mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-31 14:35:26 +00:00
Code Issues Releases Wiki Activity

Text edits to manual paages

Browse Source 
This commit updates the wording in following man pages:

* ddns-confgen.rst
* delv.rst
* dig.rst
* dnssec-dsfromkey.rst
* dnssec-importkey.rst
* dnssec-keyfromlabel.rst
* dnssec-keygen.rst
* dnssec-revoke.rst
* dnssec-settime.rst
* dnssec-signzone.rst
* dnssec-verify.rst
* dnstap-read.rst
* filter-aaaa.rst
* host.rst
* mdig.rst
* named-checkconf.rst
* named-checkzone.rst
* named-nzd2nzf.rst
* named.conf.rst
* named.rst
* nsec3hash.rst
* nsupdate.rst
* pkcs11-destroy.rst
* pkcs11-keygen.rst
* pkcs11-list.rst
* pkcs11-tokens.rst
* rndc-confgen.rst
* rndc.rst
This commit is contained in:
Suzanne Goldlust
2020-06-04 00:24:08 +00:00
committed by Ondřej Surý
parent a8faf4f7cb
commit 78af7e54e6
25 changed files with 1319 additions and 1333 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
bin/check/named-checkconf.rst
View File

@@ -35,62 +35,62 @@ Description
~~~~~~~~~~~ ~~~~~~~~~~~
``named-checkconf`` checks the syntax, but not the semantics, of a ``named-checkconf`` checks the syntax, but not the semantics, of a
``named`` configuration file. The file is parsed and checked for syntax ``named`` configuration file. The file, along with all files included by it, is parsed and checked for syntax
errors, along with all files included by it. If no file is specified, errors. If no file is specified,
``/etc/named.conf`` is read by default. ``/etc/named.conf`` is read by default.
Note: files that ``named`` reads in separate parser contexts, such as Note: files that ``named`` reads in separate parser contexts, such as
``rndc.key`` and ``bind.keys``, are not automatically read by ``rndc.key`` and ``bind.keys``, are not automatically read by
``named-checkconf``. Configuration errors in these files may cause ``named-checkconf``. Configuration errors in these files may cause
``named`` to fail to run, even if ``named-checkconf`` was successful. ``named`` to fail to run, even if ``named-checkconf`` was successful.
``named-checkconf`` can be run on these files explicitly, however. However, ``named-checkconf`` can be run on these files explicitly.
Options Options
~~~~~~~ ~~~~~~~
**-h** ``-h``
Print the usage summary and exit. This option prints the usage summary and exits.
**-j** ``-j``
When loading a zonefile read the journal if it exists. When loading a zonefile, this option instructs ``named`` to read the journal if it exists.
**-l** ``-l``
List all the configured zones. Each line of output contains the zone This option lists all the configured zones. Each line of output contains the zone
name, class (e.g. IN), view, and type (e.g. primary or secondary). name, class (e.g. IN), view, and type (e.g. primary or secondary).
**-c** ``-c``
Check "core" configuration only. This suppresses the loading of This option specifies that only the "core" configuration should be checked. This suppresses the loading of
plugin modules, and causes all parameters to ``plugin`` statements to plugin modules, and causes all parameters to ``plugin`` statements to
be ignored. be ignored.
**-i** ``-i``
Ignore warnings on deprecated options. This option ignores warnings on deprecated options.
**-p** ``-p``
Print out the ``named.conf`` and included files in canonical form if This option prints out the ``named.conf`` and included files in canonical form if
no errors were detected. See also the ``-x`` option. no errors were detected. See also the ``-x`` option.
**-t** directory ``-t directory``
Chroot to ``directory`` so that include directives in the This option instructs ``named`` to chroot to ``directory``, so that ``include`` directives in the
configuration file are processed as if run by a similarly chrooted configuration file are processed as if run by a similarly chrooted
``named``. ``named``.
**-v** ``-v``
Print the version of the ``named-checkconf`` program and exit. This option prints the version of the ``named-checkconf`` program and exits.
**-x** ``-x``
When printing the configuration files in canonical form, obscure When printing the configuration files in canonical form, this option obscures
shared secrets by replacing them with strings of question marks shared secrets by replacing them with strings of question marks
('?'). This allows the contents of ``named.conf`` and related files (``?``). This allows the contents of ``named.conf`` and related files
to be shared - for example, when submitting bug reports - to be shared - for example, when submitting bug reports -
without compromising private data. This option cannot be used without without compromising private data. This option cannot be used without
``-p``. ``-p``.
**-z** ``-z``
Perform a test load of all zones of type ``primary`` found in ``named.conf``. This option performs a test load of all zones of type ``primary`` found in ``named.conf``.
filename ``filename``
The name of the configuration file to be checked. If not specified, This indicates the name of the configuration file to be checked. If not specified,
it defaults to ``/etc/named.conf``. it defaults to ``/etc/named.conf``.
Return Values Return Values

213
bin/check/named-checkzone.rst
View File

@@ -43,163 +43,164 @@ configuring them into a name server.
``named-compilezone`` is similar to ``named-checkzone``, but it always ``named-compilezone`` is similar to ``named-checkzone``, but it always
dumps the zone contents to a specified file in a specified format. dumps the zone contents to a specified file in a specified format.
Additionally, it applies stricter check levels by default, since the It also applies stricter check levels by default, since the
dump output will be used as an actual zone file loaded by ``named``. dump output is used as an actual zone file loaded by ``named``.
When manually specified otherwise, the check levels must at least be as When manually specified otherwise, the check levels must at least be as
strict as those specified in the ``named`` configuration file. strict as those specified in the ``named`` configuration file.
Options Options
~~~~~~~ ~~~~~~~
**-d** ``-d``
Enable debugging. This option enables debugging.
**-h** ``-h``
Print the usage summary and exit. This option prints the usage summary and exits.
**-q** ``-q``
Quiet mode - exit code only. This option sets quiet mode, which only sets an exit code to indicate
successful or failed completion.
**-v** ``-v``
Print the version of the ``named-checkzone`` program and exit. This option prints the version of the ``named-checkzone`` program and exits.
**-j** ``-j``
When loading a zone file, read the journal if it exists. The journal When loading a zone file, this option tells ``named`` to read the journal if it exists. The journal
file name is assumed to be the zone file name appended with the file name is assumed to be the zone file name with the
string ``.jnl``. string ``.jnl`` appended.
**-J** filename ``-J filename``
When loading the zone file read the journal from the given file, if When loading the zone file, this option tells ``named`` to read the journal from the given file, if
it exists. (Implies -j.) it exists. This implies ``-j``.
**-c** class ``-c class``
Specify the class of the zone. If not specified, "IN" is assumed. This option specifies the class of the zone. If not specified, ``IN`` is assumed.
**-i** mode ``-i mode``
Perform post-load zone integrity checks. Possible modes are This option performs post-load zone integrity checks. Possible modes are
``"full"`` (default), ``"full-sibling"``, ``"local"``, ``full`` (the default), ``full-sibling``, ``local``,
``"local-sibling"`` and ``"none"``. ``local-sibling``, and ``none``.
Mode ``"full"`` checks that MX records refer to A or AAAA record Mode ``full`` checks that MX records refer to A or AAAA records
(both in-zone and out-of-zone hostnames). Mode ``"local"`` only (both in-zone and out-of-zone hostnames). Mode ``local`` only
checks MX records which refer to in-zone hostnames. checks MX records which refer to in-zone hostnames.
Mode ``"full"`` checks that SRV records refer to A or AAAA record Mode ``full`` checks that SRV records refer to A or AAAA records
(both in-zone and out-of-zone hostnames). Mode ``"local"`` only (both in-zone and out-of-zone hostnames). Mode ``local`` only
checks SRV records which refer to in-zone hostnames. checks SRV records which refer to in-zone hostnames.
Mode ``"full"`` checks that delegation NS records refer to A or AAAA Mode ``full`` checks that delegation NS records refer to A or AAAA
record (both in-zone and out-of-zone hostnames). It also checks that records (both in-zone and out-of-zone hostnames). It also checks that
glue address records in the zone match those advertised by the child. glue address records in the zone match those advertised by the child.
Mode ``"local"`` only checks NS records which refer to in-zone Mode ``local`` only checks NS records which refer to in-zone
hostnames or that some required glue exists, that is when the hostnames or verifies that some required glue exists, i.e., when the
nameserver is in a child zone. name server is in a child zone.
Mode ``"full-sibling"`` and ``"local-sibling"`` disable sibling glue Modes ``full-sibling`` and ``local-sibling`` disable sibling glue
checks but are otherwise the same as ``"full"`` and ``"local"`` checks, but are otherwise the same as ``full`` and ``local``,
respectively. respectively.
Mode ``"none"`` disables the checks. Mode ``none`` disables the checks.
**-f** format ``-f format``
Specify the format of the zone file. Possible formats are ``"text"`` This option specifies the format of the zone file. Possible formats are ``text``
(default), ``"raw"``, and ``"map"``. (the default), ``raw``, and ``map``.
**-F** format ``-F format``
Specify the format of the output file specified. For This option specifies the format of the output file specified. For
``named-checkzone``, this does not cause any effects unless it dumps ``named-checkzone``, this does not have any effect unless it dumps
the zone contents. the zone contents.
Possible formats are ``"text"`` (default), which is the standard Possible formats are ``text`` (the default), which is the standard
textual representation of the zone, and ``"map"``, ``"raw"``, and textual representation of the zone, and ``map``, ``raw``, and
``"raw=N"``, which store the zone in a binary format for rapid ``raw=N``, which store the zone in a binary format for rapid
loading by ``named``. ``"raw=N"`` specifies the format version of the loading by ``named``. ``raw=N`` specifies the format version of the
raw zone file: if N is 0, the raw file can be read by any version of raw zone file: if ``N`` is 0, the raw file can be read by any version of
``named``; if N is 1, the file can be read by release 9.9.0 or ``named``; if N is 1, the file can only be read by release 9.9.0 or
higher; the default is 1. higher. The default is 1.
**-k** mode ``-k mode``
Perform ``"check-names"`` checks with the specified failure mode. This option performs ``check-names`` checks with the specified failure mode.
Possible modes are ``"fail"`` (default for ``named-compilezone``), Possible modes are ``fail`` (the default for ``named-compilezone``),
``"warn"`` (default for ``named-checkzone``) and ``"ignore"``. ``warn`` (the default for ``named-checkzone``), and ``ignore``.
**-l** ttl ``-l ttl``
Sets a maximum permissible TTL for the input file. Any record with a This option sets a maximum permissible TTL for the input file. Any record with a
TTL higher than this value will cause the zone to be rejected. This TTL higher than this value causes the zone to be rejected. This
is similar to using the ``max-zone-ttl`` option in ``named.conf``. is similar to using the ``max-zone-ttl`` option in ``named.conf``.
**-L** serial ``-L serial``
When compiling a zone to "raw" or "map" format, set the "source When compiling a zone to ``raw`` or ``map`` format, this option sets the "source
serial" value in the header to the specified serial number. (This is serial" value in the header to the specified serial number. This is
expected to be used primarily for testing purposes.) expected to be used primarily for testing purposes.
**-m** mode ``-m mode``
Specify whether MX records should be checked to see if they are This option specifies whether MX records should be checked to see if they are
addresses. Possible modes are ``"fail"``, ``"warn"`` (default) and addresses. Possible modes are ``fail``, ``warn`` (the default), and
``"ignore"``. ``ignore``.
**-M** mode ``-M mode``
Check if a MX record refers to a CNAME. Possible modes are This option checks whether a MX record refers to a CNAME. Possible modes are
``"fail"``, ``"warn"`` (default) and ``"ignore"``. ``fail``, ``warn`` (the default), and ``ignore``.
**-n** mode ``-n mode``
Specify whether NS records should be checked to see if they are This option specifies whether NS records should be checked to see if they are
addresses. Possible modes are ``"fail"`` (default for addresses. Possible modes are ``fail`` (the default for
``named-compilezone``), ``"warn"`` (default for ``named-checkzone``) ``named-compilezone``), ``warn`` (the default for ``named-checkzone``),
and ``"ignore"``. and ``ignore``.
**-o** filename ``-o filename``
Write zone output to ``filename``. If ``filename`` is ``-`` then This option writes the zone output to ``filename``. If ``filename`` is ``-``, then
write to standard out. This is mandatory for ``named-compilezone``. the zone output is written to standard output. This is mandatory for ``named-compilezone``.
**-r** mode ``-r mode``
Check for records that are treated as different by DNSSEC but are This option checks for records that are treated as different by DNSSEC but are
semantically equal in plain DNS. Possible modes are ``"fail"``, semantically equal in plain DNS. Possible modes are ``fail``,
``"warn"`` (default) and ``"ignore"``. ``warn`` (the default), and ``ignore``.
**-s** style ``-s style``
Specify the style of the dumped zone file. Possible styles are This option specifies the style of the dumped zone file. Possible styles are
``"full"`` (default) and ``"relative"``. The full format is most ``full`` (the default) and ``relative``. The ``full`` format is most
suitable for processing automatically by a separate script. On the suitable for processing automatically by a separate script.
other hand, the relative format is more human-readable and is thus The relative format is more human-readable and is thus
suitable for editing by hand. For ``named-checkzone`` this does not suitable for editing by hand. For ``named-checkzone``, this does not
cause any effects unless it dumps the zone contents. It also does not have any effect unless it dumps the zone contents. It also does not
have any meaning if the output format is not text. have any meaning if the output format is not text.
**-S** mode ``-S mode``
Check if a SRV record refers to a CNAME. Possible modes are This option checks whether an SRV record refers to a CNAME. Possible modes are
``"fail"``, ``"warn"`` (default) and ``"ignore"``. ``fail``, ``warn`` (the default), and ``ignore``.
**-t** directory ``-t directory``
Chroot to ``directory`` so that include directives in the This option tells ``named`` to chroot to ``directory``, so that ``include`` directives in the
configuration file are processed as if run by a similarly chrooted configuration file are processed as if run by a similarly chrooted
``named``. ``named``.
**-T** mode ``-T mode``
Check if Sender Policy Framework (SPF) records exist and issues a This option checks whether Sender Policy Framework (SPF) records exist and issues a
warning if an SPF-formatted TXT record is not also present. Possible warning if an SPF-formatted TXT record is not also present. Possible
modes are ``"warn"`` (default), ``"ignore"``. modes are ``warn`` (the default) and ``ignore``.
**-w** directory ``-w directory``
chdir to ``directory`` so that relative filenames in master file This option instructs ``named`` to chdir to ``directory``, so that relative filenames in master file
$INCLUDE directives work. This is similar to the directory clause in ``$INCLUDE`` directives work. This is similar to the directory clause in
``named.conf``. ``named.conf``.
**-D** ``-D``
Dump zone file in canonical format. This is always enabled for This option dumps the zone file in canonical format. This is always enabled for
``named-compilezone``. ``named-compilezone``.
**-W** mode ``-W mode``
Specify whether to check for non-terminal wildcards. Non-terminal This option specifies whether to check for non-terminal wildcards. Non-terminal
wildcards are almost always the result of a failure to understand the wildcards are almost always the result of a failure to understand the
wildcard matching algorithm (:rfc:`1034`). Possible modes are ``"warn"`` wildcard matching algorithm (:rfc:`1034`). Possible modes are ``warn``
(default) and ``"ignore"``. (the default) and ``ignore``.
zonename ``zonename``
The domain name of the zone being checked. This indicates the domain name of the zone being checked.
filename ``filename``
The name of the zone file. This is the name of the zone file.
Return Values Return Values
~~~~~~~~~~~~~ ~~~~~~~~~~~~~

42
bin/confgen/ddns-confgen.rst
View File

@@ -41,17 +41,17 @@ can be used, for example, to secure dynamic DNS updates to a zone or for
the ``rndc`` command channel. the ``rndc`` command channel.
When run as ``tsig-keygen``, a domain name can be specified on the When run as ``tsig-keygen``, a domain name can be specified on the
command line which will be used as the name of the generated key. If no command line to be used as the name of the generated key. If no
name is specified, the default is ``tsig-key``. name is specified, the default is ``tsig-key``.
When run as ``ddns-confgen``, the generated key is accompanied by When run as ``ddns-confgen``, the generated key is accompanied by
configuration text and instructions that can be used with ``nsupdate`` configuration text and instructions that can be used with ``nsupdate``
and ``named`` when setting up dynamic DNS, including an example and ``named`` when setting up dynamic DNS, including an example
``update-policy`` statement. (This usage similar to the ``rndc-confgen`` ``update-policy`` statement. (This usage is similar to the ``rndc-confgen``
command for setting up command channel security.) command for setting up command-channel security.)
Note that ``named`` itself can configure a local DDNS key for use with Note that ``named`` itself can configure a local DDNS key for use with
``nsupdate -l``: it does this when a zone is configured with ``nsupdate -l``; it does this when a zone is configured with
``update-policy local;``. ``ddns-confgen`` is only needed when a more ``update-policy local;``. ``ddns-confgen`` is only needed when a more
elaborate configuration is required: for instance, if ``nsupdate`` is to elaborate configuration is required: for instance, if ``nsupdate`` is to
be used from a remote system. be used from a remote system.
@@ -59,40 +59,40 @@ be used from a remote system.
Options Options
~~~~~~~ ~~~~~~~
**-a** algorithm ``-a algorithm``
Specifies the algorithm to use for the TSIG key. Available choices This option specifies the algorithm to use for the TSIG key. Available choices
are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, and
hmac-sha512. The default is hmac-sha256. Options are hmac-sha512. The default is hmac-sha256. Options are
case-insensitive, and the "hmac-" prefix may be omitted. case-insensitive, and the "hmac-" prefix may be omitted.
**-h** ``-h``
Prints a short summary of options and arguments. This option prints a short summary of options and arguments.
**-k** keyname ``-k keyname``
Specifies the key name of the DDNS authentication key. The default is This option specifies the key name of the DDNS authentication key. The default is
``ddns-key`` when neither the ``-s`` nor ``-z`` option is specified; ``ddns-key`` when neither the ``-s`` nor ``-z`` option is specified;
otherwise, the default is ``ddns-key`` as a separate label followed otherwise, the default is ``ddns-key`` as a separate label followed
by the argument of the option, e.g., ``ddns-key.example.com.`` The by the argument of the option, e.g., ``ddns-key.example.com.`` The
key name must have the format of a valid domain name, consisting of key name must have the format of a valid domain name, consisting of
letters, digits, hyphens and periods. letters, digits, hyphens, and periods.
**-q** ``-q`` (``ddns-confgen`` only)
(``ddns-confgen`` only.) Quiet mode: Print only the key, with no This option enables quiet mode, which prints only the key, with no
explanatory text or usage examples; This is essentially identical to explanatory text or usage examples. This is essentially identical to
``tsig-keygen``. ``tsig-keygen``.
**-s** name ``-s name`` (``ddns-confgen`` only)
(``ddns-confgen`` only.) Generate configuration example to allow This option generates a configuration example to allow
dynamic updates of a single hostname. The example ``named.conf`` text dynamic updates of a single hostname. The example ``named.conf`` text
shows how to set an update policy for the specified name using the shows how to set an update policy for the specified name using the
"name" nametype. The default key name is ddns-key.name. Note that the "name" nametype. The default key name is ``ddns-key.name``. Note that the
"self" nametype cannot be used, since the name to be updated may "self" nametype cannot be used, since the name to be updated may
differ from the key name. This option cannot be used with the ``-z`` differ from the key name. This option cannot be used with the ``-z``
option. option.
**-z** zone ``-z zone`` (``ddns-confgen`` only)
(``ddns-confgen`` only.) Generate configuration example to allow This option generates a configuration example to allow
dynamic updates of a zone: The example ``named.conf`` text shows how dynamic updates of a zone. The example ``named.conf`` text shows how
to set an update policy for the specified zone using the "zonesub" to set an update policy for the specified zone using the "zonesub"
nametype, allowing updates to all subdomain names within that zone. nametype, allowing updates to all subdomain names within that zone.
This option cannot be used with the ``-s`` option. This option cannot be used with the ``-s`` option.

72
bin/confgen/rndc-confgen.rst
View File

@@ -41,79 +41,75 @@ by hand. Alternatively, it can be run with the ``-a`` option to set up a
``rndc.key`` file and avoid the need for a ``rndc.conf`` file and a ``rndc.key`` file and avoid the need for a ``rndc.conf`` file and a
``controls`` statement altogether. ``controls`` statement altogether.
Arguments Options
~~~~~~~~~ ~~~~~~~
**-a** ``-a``
Do automatic ``rndc`` configuration. This creates a file ``rndc.key`` This option sets automatic ``rndc`` configuration, which creates a file ``rndc.key``
in ``/etc`` (or whatever ``sysconfdir`` was specified as when BIND in ``/etc`` (or a different ``sysconfdir`` specified when BIND
was built) that is read by both ``rndc`` and ``named`` on startup. was built) that is read by both ``rndc`` and ``named`` on startup.
The ``rndc.key`` file defines a default command channel and The ``rndc.key`` file defines a default command channel and
authentication key allowing ``rndc`` to communicate with ``named`` on authentication key allowing ``rndc`` to communicate with ``named`` on
the local host with no further configuration. the local host with no further configuration.
Running ``rndc-confgen -a`` allows BIND 9 and ``rndc`` to be used as
drop-in replacements for BIND 8 and ``ndc``, with no changes to the
existing BIND 8 ``named.conf`` file.
If a more elaborate configuration than that generated by If a more elaborate configuration than that generated by
``rndc-confgen -a`` is required, for example if rndc is to be used ``rndc-confgen -a`` is required, for example if rndc is to be used
remotely, you should run ``rndc-confgen`` without the ``-a`` option remotely, run ``rndc-confgen`` without the ``-a`` option
and set up a ``rndc.conf`` and ``named.conf`` as directed. and set up ``rndc.conf`` and ``named.conf`` as directed.
**-A** algorithm ``-A algorithm``
Specifies the algorithm to use for the TSIG key. Available choices This option specifies the algorithm to use for the TSIG key. Available choices
are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, and
hmac-sha512. The default is hmac-sha256. hmac-sha512. The default is hmac-sha256.
**-b** keysize ``-b keysize``
Specifies the size of the authentication key in bits. Must be between This option specifies the size of the authentication key in bits. The size must be between
1 and 512 bits; the default is the hash size. 1 and 512 bits; the default is the hash size.
**-c** keyfile ``-c keyfile``
Used with the ``-a`` option to specify an alternate location for This option is used with the ``-a`` option to specify an alternate location for
``rndc.key``. ``rndc.key``.
**-h** ``-h``
Prints a short summary of the options and arguments to This option prints a short summary of the options and arguments to
``rndc-confgen``. ``rndc-confgen``.
**-k** keyname ``-k keyname``
Specifies the key name of the rndc authentication key. This must be a This option specifies the key name of the ``rndc`` authentication key. This must be a
valid domain name. The default is ``rndc-key``. valid domain name. The default is ``rndc-key``.
**-p** port ``-p port``
Specifies the command channel port where ``named`` listens for This option specifies the command channel port where ``named`` listens for
connections from ``rndc``. The default is 953. connections from ``rndc``. The default is 953.
**-q** ``-q``
Omits printing written path in automatic configuration mode. This option prevets printing the written path in automatic configuration mode.
**-s** address ``-s address``
Specifies the IP address where ``named`` listens for command channel This option specifies the IP address where ``named`` listens for command-channel
connections from ``rndc``. The default is the loopback address connections from ``rndc``. The default is the loopback address
127.0.0.1. 127.0.0.1.
**-t** chrootdir ``-t chrootdir``
Used with the ``-a`` option to specify a directory where ``named`` This option is used with the ``-a`` option to specify a directory where ``named``
will run chrooted. An additional copy of the ``rndc.key`` will be runs chrooted. An additional copy of the ``rndc.key`` is
written relative to this directory so that it will be found by the written relative to this directory, so that it is found by the
chrooted ``named``. chrooted ``named``.
**-u** user ``-u user``
Used with the ``-a`` option to set the owner of the ``rndc.key`` file This option is used with the ``-a`` option to set the owner of the generated ``rndc.key`` file.
generated. If ``-t`` is also specified only the file in the chroot If ``-t`` is also specified, only the file in the chroot
area has its owner changed. area has its owner changed.
Examples Examples
~~~~~~~~ ~~~~~~~~
To allow ``rndc`` to be used with no manual configuration, run To allow ``rndc`` to be used with no manual configuration, run:
``rndc-confgen -a`` ``rndc-confgen -a``
To print a sample ``rndc.conf`` file and corresponding ``controls`` and To print a sample ``rndc.conf`` file and the corresponding ``controls`` and
``key`` statements to be manually inserted into ``named.conf``, run ``key`` statements to be manually inserted into ``named.conf``, run:
``rndc-confgen`` ``rndc-confgen``

178
bin/delv/delv.rst
View File

@@ -43,15 +43,15 @@ Description
``delv`` is a tool for sending DNS queries and validating the results, ``delv`` is a tool for sending DNS queries and validating the results,
using the same internal resolver and validator logic as ``named``. using the same internal resolver and validator logic as ``named``.
``delv`` will send to a specified name server all queries needed to ``delv`` sends to a specified name server all queries needed to
fetch and validate the requested data; this includes the original fetch and validate the requested data; this includes the original
requested query, subsequent queries to follow CNAME or DNAME chains, and requested query, subsequent queries to follow CNAME or DNAME chains,
queries for DNSKEY, and DS records to establish a chain of trust for queries for DNSKEY, and DS records to establish a chain of trust for
DNSSEC validation. It does not perform iterative resolution, but DNSSEC validation. It does not perform iterative resolution, but
simulates the behavior of a name server configured for DNSSEC validating simulates the behavior of a name server configured for DNSSEC validating
and forwarding. and forwarding.
By default, responses are validated using built-in DNSSEC trust anchor By default, responses are validated using the built-in DNSSEC trust anchor
for the root zone ("."). Records returned by ``delv`` are either fully for the root zone ("."). Records returned by ``delv`` are either fully
validated or were not signed. If validation fails, an explanation of the validated or were not signed. If validation fails, an explanation of the
failure is included in the output; the validation process can be traced failure is included in the output; the validation process can be traced
@@ -59,13 +59,13 @@ in detail. Because ``delv`` does not rely on an external server to carry
out validation, it can be used to check the validity of DNS responses in out validation, it can be used to check the validity of DNS responses in
environments where local name servers may not be trustworthy. environments where local name servers may not be trustworthy.
Unless it is told to query a specific name server, ``delv`` will try Unless it is told to query a specific name server, ``delv`` tries
each of the servers listed in ``/etc/resolv.conf``. If no usable server each of the servers listed in ``/etc/resolv.conf``. If no usable server
addresses are found, ``delv`` will send queries to the localhost addresses are found, ``delv`` sends queries to the localhost
addresses (127.0.0.1 for IPv4, ::1 for IPv6). addresses (127.0.0.1 for IPv4, ::1 for IPv6).
When no command line arguments or options are given, ``delv`` will When no command-line arguments or options are given, ``delv``
perform an NS query for "." (the root zone). performs an NS query for "." (the root zone).
Simple Usage Simple Usage
~~~~~~~~~~~~ ~~~~~~~~~~~~
@@ -89,109 +89,109 @@ where:
If no ``server`` argument is provided, ``delv`` consults If no ``server`` argument is provided, ``delv`` consults
``/etc/resolv.conf``; if an address is found there, it queries the ``/etc/resolv.conf``; if an address is found there, it queries the
name server at that address. If either of the ``-4`` or ``-6`` name server at that address. If either of the ``-4`` or ``-6``
options are in use, then only addresses for the corresponding options is in use, then only addresses for the corresponding
transport will be tried. If no usable addresses are found, ``delv`` transport are tried. If no usable addresses are found, ``delv``
will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 sends queries to the localhost addresses (127.0.0.1 for IPv4, ::1
for IPv6). for IPv6).
``name`` ``name``
is the domain name to be looked up. is the domain name to be looked up.
``type`` ``type``
indicates what type of query is required MDASH ANY, A, MX, etc. indicates what type of query is required - ANY, A, MX, etc.
``type`` can be any valid query type. If no ``type`` argument is ``type`` can be any valid query type. If no ``type`` argument is
supplied, ``delv`` will perform a lookup for an A record. supplied, ``delv`` performs a lookup for an A record.
Options Options
~~~~~~~ ~~~~~~~
**-a** anchor-file ``-a anchor-file``
Specifies a file from which to read DNSSEC trust anchors. The default This option specifies a file from which to read DNSSEC trust anchors. The default
is ``/etc/bind.keys``, which is included with BIND 9 and contains one is ``/etc/bind.keys``, which is included with BIND 9 and contains one
or more trust anchors for the root zone ("."). or more trust anchors for the root zone (".").
Keys that do not match the root zone name are ignored. An alternate Keys that do not match the root zone name are ignored. An alternate
key name can be specified using the ``+root=NAME`` options. key name can be specified using the ``+root=NAME`` options.
Note: When reading the trust anchor file, ``delv`` treat ``trust-anchors`` Note: When reading the trust anchor file, ``delv`` treats ``trust-anchors``,
``initial-key`` and ``static-key`` identically. That is, for a managed key, ``initial-key``, and ``static-key`` identically. That is, for a managed key,
it is the *initial* key that is trusted; :rfc:`5011` key management is not it is the *initial* key that is trusted; :rfc:`5011` key management is not
supported. ``delv`` will not consult the managed-keys database maintained by supported. ``delv`` does not consult the managed-keys database maintained by
``named``. This means that if either of the keys in ``/etc/bind.keys`` is ``named``, which means that if either of the keys in ``/etc/bind.keys`` is
revoked and rolled over, it will be necessary to update ``/etc/bind.keys`` to revoked and rolled over, ``/etc/bind.keys`` must be updated to
use DNSSEC validation in ``delv``. use DNSSEC validation in ``delv``.
**-b** address ``-b address``
Sets the source IP address of the query to ``address``. This must be This option sets the source IP address of the query to ``address``. This must be
a valid address on one of the host's network interfaces or "0.0.0.0" a valid address on one of the host's network interfaces, or ``0.0.0.0``,
or "::". An optional source port may be specified by appending or ``::``. An optional source port may be specified by appending
"#<port>" ``#<port>``
**-c** class ``-c class``
Sets the query class for the requested data. Currently, only class This option sets the query class for the requested data. Currently, only class
"IN" is supported in ``delv`` and any other value is ignored. "IN" is supported in ``delv`` and any other value is ignored.
**-d** level ``-d level``
Set the systemwide debug level to ``level``. The allowed range is This option sets the systemwide debug level to ``level``. The allowed range is
from 0 to 99. The default is 0 (no debugging). Debugging traces from from 0 to 99. The default is 0 (no debugging). Debugging traces from
``delv`` become more verbose as the debug level increases. See the ``delv`` become more verbose as the debug level increases. See the
``+mtrace``, ``+rtrace``, and ``+vtrace`` options below for ``+mtrace``, ``+rtrace``, and ``+vtrace`` options below for
additional debugging details. additional debugging details.
**-h** ``-h``
Display the ``delv`` help usage output and exit. This option displays the ``delv`` help usage output and exits.
**-i** ``-i``
Insecure mode. This disables internal DNSSEC validation. (Note, This option sets insecure mode, which disables internal DNSSEC validation. (Note,
however, this does not set the CD bit on upstream queries. If the however, that this does not set the CD bit on upstream queries. If the
server being queried is performing DNSSEC validation, then it will server being queried is performing DNSSEC validation, then it does
not return invalid data; this can cause ``delv`` to time out. When it not return invalid data; this can cause ``delv`` to time out. When it
is necessary to examine invalid data to debug a DNSSEC problem, use is necessary to examine invalid data to debug a DNSSEC problem, use
``dig +cd``.) ``dig +cd``.)
**-m** ``-m``
Enables memory usage debugging. This option enables memory usage debugging.
**-p** port# ``-p port#``
Specifies a destination port to use for queries instead of the This option specifies a destination port to use for queries, instead of the
standard DNS port number 53. This option would be used with a name standard DNS port number 53. This option is used with a name
server that has been configured to listen for queries on a server that has been configured to listen for queries on a
non-standard port number. non-standard port number.
**-q** name ``-q name``
Sets the query name to ``name``. While the query name can be This option sets the query name to ``name``. While the query name can be
specified without using the ``-q``, it is sometimes necessary to specified without using the ``-q`` option, it is sometimes necessary to
disambiguate names from types or classes (for example, when looking disambiguate names from types or classes (for example, when looking
up the name "ns", which could be misinterpreted as the type NS, or up the name "ns", which could be misinterpreted as the type NS, or
"ch", which could be misinterpreted as class CH). "ch", which could be misinterpreted as class CH).
**-t** type ``-t type``
Sets the query type to ``type``, which can be any valid query type This option sets the query type to ``type``, which can be any valid query type
supported in BIND 9 except for zone transfer types AXFR and IXFR. As supported in BIND 9 except for zone transfer types AXFR and IXFR. As
with ``-q``, this is useful to distinguish query name type or class with ``-q``, this is useful to distinguish query-name types or classes
when they are ambiguous. it is sometimes necessary to disambiguate when they are ambiguous. It is sometimes necessary to disambiguate
names from types. names from types.
The default query type is "A", unless the ``-x`` option is supplied The default query type is "A", unless the ``-x`` option is supplied
to indicate a reverse lookup, in which case it is "PTR". to indicate a reverse lookup, in which case it is "PTR".
**-v** ``-v``
Print the ``delv`` version and exit. This option prints the ``delv`` version and exits.
**-x** addr ``-x addr``
Performs a reverse lookup, mapping an addresses to a name. ``addr`` This option performs a reverse lookup, mapping an address to a name. ``addr``
is an IPv4 address in dotted-decimal notation, or a colon-delimited is an IPv4 address in dotted-decimal notation, or a colon-delimited
IPv6 address. When ``-x`` is used, there is no need to provide the IPv6 address. When ``-x`` is used, there is no need to provide the
``name`` or ``type`` arguments. ``delv`` automatically performs a ``name`` or ``type`` arguments; ``delv`` automatically performs a
lookup for a name like ``11.12.13.10.in-addr.arpa`` and sets the lookup for a name like ``11.12.13.10.in-addr.arpa`` and sets the
query type to PTR. IPv6 addresses are looked up using nibble format query type to PTR. IPv6 addresses are looked up using nibble format
under the IP6.ARPA domain. under the IP6.ARPA domain.
**-4** ``-4``
Forces ``delv`` to only use IPv4. This option forces ``delv`` to only use IPv4.
**-6** ``-6``
Forces ``delv`` to only use IPv6. This option forces ``delv`` to only use IPv6.
Query Options Query Options
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@@ -206,122 +206,122 @@ assign values to options like the timeout interval. They have the form
``+keyword=value``. The query options are: ``+keyword=value``. The query options are:
``+[no]cdflag`` ``+[no]cdflag``
Controls whether to set the CD (checking disabled) bit in queries This option controls whether to set the CD (checking disabled) bit in queries
sent by ``delv``. This may be useful when troubleshooting DNSSEC sent by ``delv``. This may be useful when troubleshooting DNSSEC
problems from behind a validating resolver. A validating resolver problems from behind a validating resolver. A validating resolver
will block invalid responses, making it difficult to retrieve them blocks invalid responses, making it difficult to retrieve them
for analysis. Setting the CD flag on queries will cause the resolver for analysis. Setting the CD flag on queries causes the resolver
to return invalid responses, which ``delv`` can then validate to return invalid responses, which ``delv`` can then validate
internally and report the errors in detail. internally and report the errors in detail.
``+[no]class`` ``+[no]class``
Controls whether to display the CLASS when printing a record. The This option controls whether to display the CLASS when printing a record. The
default is to display the CLASS. default is to display the CLASS.
``+[no]ttl`` ``+[no]ttl``
Controls whether to display the TTL when printing a record. The This option controls whether to display the TTL when printing a record. The
default is to display the TTL. default is to display the TTL.
``+[no]rtrace`` ``+[no]rtrace``
Toggle resolver fetch logging. This reports the name and type of each This option toggles resolver fetch logging. This reports the name and type of each
query sent by ``delv`` in the process of carrying out the resolution query sent by ``delv`` in the process of carrying out the resolution
and validation process: this includes including the original query and validation process, including the original query
and all subsequent queries to follow CNAMEs and to establish a chain and all subsequent queries to follow CNAMEs and to establish a chain
of trust for DNSSEC validation. of trust for DNSSEC validation.
This is equivalent to setting the debug level to 1 in the "resolver" This is equivalent to setting the debug level to 1 in the "resolver"
logging category. Setting the systemwide debug level to 1 using the logging category. Setting the systemwide debug level to 1 using the
``-d`` option will product the same output (but will affect other ``-d`` option produces the same output, but affects other
logging categories as well). logging categories as well.
``+[no]mtrace`` ``+[no]mtrace``
Toggle message logging. This produces a detailed dump of the This option toggles message logging. This produces a detailed dump of the
responses received by ``delv`` in the process of carrying out the responses received by ``delv`` in the process of carrying out the
resolution and validation process. resolution and validation process.
This is equivalent to setting the debug level to 10 for the "packets" This is equivalent to setting the debug level to 10 for the "packets"
module of the "resolver" logging category. Setting the systemwide module of the "resolver" logging category. Setting the systemwide
debug level to 10 using the ``-d`` option will produce the same debug level to 10 using the ``-d`` option produces the same
output (but will affect other logging categories as well). output, but affects other logging categories as well.
``+[no]vtrace`` ``+[no]vtrace``
Toggle validation logging. This shows the internal process of the This option toggles validation logging. This shows the internal process of the
validator as it determines whether an answer is validly signed, validator as it determines whether an answer is validly signed,
unsigned, or invalid. unsigned, or invalid.
This is equivalent to setting the debug level to 3 for the This is equivalent to setting the debug level to 3 for the
"validator" module of the "dnssec" logging category. Setting the "validator" module of the "dnssec" logging category. Setting the
systemwide debug level to 3 using the ``-d`` option will produce the systemwide debug level to 3 using the ``-d`` option produces the
same output (but will affect other logging categories as well). same output, but affects other logging categories as well.
``+[no]short`` ``+[no]short``
Provide a terse answer. The default is to print the answer in a This option toggles between verbose and terse answers. The default is to print the answer in a
verbose form. verbose form.
``+[no]comments`` ``+[no]comments``
Toggle the display of comment lines in the output. The default is to This option toggles the display of comment lines in the output. The default is to
print comments. print comments.
``+[no]rrcomments`` ``+[no]rrcomments``
Toggle the display of per-record comments in the output (for example, This option toggles the display of per-record comments in the output (for example,
human-readable key information about DNSKEY records). The default is human-readable key information about DNSKEY records). The default is
to print per-record comments. to print per-record comments.
``+[no]crypto`` ``+[no]crypto``
Toggle the display of cryptographic fields in DNSSEC records. The This option toggles the display of cryptographic fields in DNSSEC records. The
contents of these field are unnecessary to debug most DNSSEC contents of these fields are unnecessary to debug most DNSSEC
validation failures and removing them makes it easier to see the validation failures and removing them makes it easier to see the
common failures. The default is to display the fields. When omitted common failures. The default is to display the fields. When omitted,
they are replaced by the string "[omitted]" or in the DNSKEY case the they are replaced by the string ``[omitted]`` or, in the DNSKEY case, the
key id is displayed as the replacement, e.g. "[ key id = value ]". key ID is displayed as the replacement, e.g. ``[ key id = value ]``.
``+[no]trust`` ``+[no]trust``
Controls whether to display the trust level when printing a record. This option controls whether to display the trust level when printing a record.
The default is to display the trust level. The default is to display the trust level.
``+[no]split[=W]`` ``+[no]split[=W]``
Split long hex- or base64-formatted fields in resource records into This option splits long hex- or base64-formatted fields in resource records into
chunks of ``W`` characters (where ``W`` is rounded up to the nearest chunks of ``W`` characters (where ``W`` is rounded up to the nearest
multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be
split at all. The default is 56 characters, or 44 characters when split at all. The default is 56 characters, or 44 characters when
multiline mode is active. multiline mode is active.
``+[no]all`` ``+[no]all``
Set or clear the display options ``+[no]comments``, This option sets or clears the display options ``+[no]comments``,
``+[no]rrcomments``, and ``+[no]trust`` as a group. ``+[no]rrcomments``, and ``+[no]trust`` as a group.
``+[no]multiline`` ``+[no]multiline``
Print long records (such as RRSIG, DNSKEY, and SOA records) in a This option prints long records (such as RRSIG, DNSKEY, and SOA records) in a
verbose multi-line format with human-readable comments. The default verbose multi-line format with human-readable comments. The default
is to print each record on a single line, to facilitate machine is to print each record on a single line, to facilitate machine
parsing of the ``delv`` output. parsing of the ``delv`` output.
``+[no]dnssec`` ``+[no]dnssec``
Indicates whether to display RRSIG records in the ``delv`` output. This option indicates whether to display RRSIG records in the ``delv`` output.
The default is to do so. Note that (unlike in ``dig``) this does The default is to do so. Note that (unlike in ``dig``) this does
*not* control whether to request DNSSEC records or whether to *not* control whether to request DNSSEC records or to
validate them. DNSSEC records are always requested, and validation validate them. DNSSEC records are always requested, and validation
will always occur unless suppressed by the use of ``-i`` or always occurs unless suppressed by the use of ``-i`` or
``+noroot``. ``+noroot``.
``+[no]root[=ROOT]`` ``+[no]root[=ROOT]``
Indicates whether to perform conventional DNSSEC validation, and if so, This option indicates whether to perform conventional DNSSEC validation, and if so,
specifies the name of a trust anchor. The default is to validate using a specifies the name of a trust anchor. The default is to validate using a
trust anchor of "." (the root zone), for which there is a built-in key. If trust anchor of "." (the root zone), for which there is a built-in key. If
specifying a different trust anchor, then ``-a`` must be used to specify a specifying a different trust anchor, then ``-a`` must be used to specify a
file containing the key. file containing the key.
``+[no]tcp`` ``+[no]tcp``
Controls whether to use TCP when sending queries. The default is to This option controls whether to use TCP when sending queries. The default is to
use UDP unless a truncated response has been received. use UDP unless a truncated response has been received.
``+[no]unknownformat`` ``+[no]unknownformat``
Print all RDATA in unknown RR type presentation format (:rfc:`3597`). This option prints all RDATA in unknown RR-type presentation format (:rfc:`3597`).
The default is to print RDATA for known types in the type's The default is to print RDATA for known types in the type's
presentation format. presentation format.
``+[no]yaml`` ``+[no]yaml``
Print response data in YAML format. This option prints response data in YAML format.
Files Files
~~~~~ ~~~~~

398
bin/dig/dig.rst
View File

@@ -40,33 +40,33 @@ Description
``dig`` is a flexible tool for interrogating DNS name servers. It ``dig`` is a flexible tool for interrogating DNS name servers. It
performs DNS lookups and displays the answers that are returned from the performs DNS lookups and displays the answers that are returned from the
name server(s) that were queried. Most DNS administrators use ``dig`` to name server(s) that were queried. Most DNS administrators use ``dig`` to
troubleshoot DNS problems because of its flexibility, ease of use and troubleshoot DNS problems because of its flexibility, ease of use, and
clarity of output. Other lookup tools tend to have less functionality clarity of output. Other lookup tools tend to have less functionality
than ``dig``. than ``dig``.
Although ``dig`` is normally used with command-line arguments, it also Although ``dig`` is normally used with command-line arguments, it also
has a batch mode of operation for reading lookup requests from a file. A has a batch mode of operation for reading lookup requests from a file. A
brief summary of its command-line arguments and options is printed when brief summary of its command-line arguments and options is printed when
the ``-h`` option is given. Unlike earlier versions, the BIND 9 the ``-h`` option is given. The BIND 9
implementation of ``dig`` allows multiple lookups to be issued from the implementation of ``dig`` allows multiple lookups to be issued from the
command line. command line.
Unless it is told to query a specific name server, ``dig`` will try each Unless it is told to query a specific name server, ``dig`` tries each
of the servers listed in ``/etc/resolv.conf``. If no usable server of the servers listed in ``/etc/resolv.conf``. If no usable server
addresses are found, ``dig`` will send the query to the local host. addresses are found, ``dig`` sends the query to the local host.
When no command line arguments or options are given, ``dig`` will When no command-line arguments or options are given, ``dig``
perform an NS query for "." (the root). performs an NS query for "." (the root).
It is possible to set per-user defaults for ``dig`` via It is possible to set per-user defaults for ``dig`` via
``${HOME}/.digrc``. This file is read and any options in it are applied ``${HOME}/.digrc``. This file is read and any options in it are applied
before the command line arguments. The ``-r`` option disables this before the command-line arguments. The ``-r`` option disables this
feature, for scripts that need predictable behaviour. feature, for scripts that need predictable behavior.
The IN and CH class names overlap with the IN and CH top level domain The IN and CH class names overlap with the IN and CH top-level domain
names. Either use the ``-t`` and ``-c`` options to specify the type and names. Either use the ``-t`` and ``-c`` options to specify the type and
class, use the ``-q`` the specify the domain name, or use "IN." and class, use the ``-q`` to specify the domain name, or use "IN." and
"CH." when looking up these top level domains. "CH." when looking up these top-level domains.
Simple Usage Simple Usage
~~~~~~~~~~~~ ~~~~~~~~~~~~
@@ -90,110 +90,110 @@ where:
``/etc/resolv.conf``; if an address is found there, it queries the ``/etc/resolv.conf``; if an address is found there, it queries the
name server at that address. If either of the ``-4`` or ``-6`` name server at that address. If either of the ``-4`` or ``-6``
options are in use, then only addresses for the corresponding options are in use, then only addresses for the corresponding
transport will be tried. If no usable addresses are found, ``dig`` transport are tried. If no usable addresses are found, ``dig``
will send the query to the local host. The reply from the name server sends the query to the local host. The reply from the name server
that responds is displayed. that responds is displayed.
``name`` ``name``
is the name of the resource record that is to be looked up. is the name of the resource record that is to be looked up.
``type`` ``type``
indicates what type of query is required MDASH ANY, A, MX, SIG, etc. indicates what type of query is required - ANY, A, MX, SIG, etc.
``type`` can be any valid query type. If no ``type`` argument is ``type`` can be any valid query type. If no ``type`` argument is
supplied, ``dig`` will perform a lookup for an A record. supplied, ``dig`` performs a lookup for an A record.
Options Options
~~~~~~~ ~~~~~~~
**-4** ``-4``
Use IPv4 only. This option indicates that only IPv4 should be used.
**-6** ``-6``
Use IPv6 only. This option indicates that only IPv6 should be used.
**-b** address[#port] ``-b address[#port]``
Set the source IP address of the query. The ``address`` must be a This option sets the source IP address of the query. The ``address`` must be a
valid address on one of the host's network interfaces, or "0.0.0.0" valid address on one of the host's network interfaces, or "0.0.0.0"
or "::". An optional port may be specified by appending "#<port>" or "::". An optional port may be specified by appending ``#port``.
**-c** class ``-c class``
Set the query class. The default ``class`` is IN; other classes are This option sets the query class. The default ``class`` is IN; other classes are
HS for Hesiod records or CH for Chaosnet records. HS for Hesiod records or CH for Chaosnet records.
**-f** file ``-f file``
Batch mode: ``dig`` reads a list of lookup requests to process from This option sets batch mode, in which ``dig`` reads a list of lookup requests to process from
the given ``file``. Each line in the file should be organized in the the given ``file``. Each line in the file should be organized in the
same way they would be presented as queries to ``dig`` using the same way it would be presented as a query to ``dig`` using the
command-line interface. command-line interface.
**-k** keyfile ``-k keyfile``
Sign queries using TSIG using a key read from the given file. Key This option tells ``named`` to sign queries using TSIG using a key read from the given file. Key
files can be generated using tsig-keygen8. When using TSIG files can be generated using ``tsig-keygen``. When using TSIG
authentication with ``dig``, the name server that is queried needs to authentication with ``dig``, the name server that is queried needs to
know the key and algorithm that is being used. In BIND, this is done know the key and algorithm that is being used. In BIND, this is done
by providing appropriate ``key`` and ``server`` statements in by providing appropriate ``key`` and ``server`` statements in
``named.conf``. ``named.conf``.
**-m** ``-m``
Enable memory usage debugging. This option enables memory usage debugging.
**-p** port ``-p port``
Send the query to a non-standard port on the server, instead of the This option sends the query to a non-standard port on the server, instead of the
default port 53. This option would be used to test a name server that default port 53. This option is used to test a name server that
has been configured to listen for queries on a non-standard port has been configured to listen for queries on a non-standard port
number. number.
**-q** name ``-q name``
The domain name to query. This is useful to distinguish the ``name`` This option specifies the domain name to query. This is useful to distinguish the ``name``
from other arguments. from other arguments.
**-r** ``-r``
Do not read options from ``${HOME}/.digrc``. This is useful for This option indicates that options from ``${HOME}/.digrc`` should not be read. This is useful for
scripts that need predictable behaviour. scripts that need predictable behavior.
**-t** type ``-t type``
The resource record type to query. It can be any valid query type. If This option indicates the resource record type to query, which can be any valid query type. If
it is a resource record type supported in BIND 9, it can be given by it is a resource record type supported in BIND 9, it can be given by
the type mnemonic (such as "NS" or "AAAA"). The default query type is the type mnemonic (such as ``NS`` or ``AAAA``). The default query type is
"A", unless the ``-x`` option is supplied to indicate a reverse ``A``, unless the ``-x`` option is supplied to indicate a reverse
lookup. A zone transfer can be requested by specifying a type of lookup. A zone transfer can be requested by specifying a type of
AXFR. When an incremental zone transfer (IXFR) is required, set the AXFR. When an incremental zone transfer (IXFR) is required, set the
``type`` to ``ixfr=N``. The incremental zone transfer will contain ``type`` to ``ixfr=N``. The incremental zone transfer contains
the changes made to the zone since the serial number in the zone's all changes made to the zone since the serial number in the zone's
SOA record was ``N``. SOA record was ``N``.
All resource record types can be expressed as "TYPEnn", where "nn" is All resource record types can be expressed as ``TYPEnn``, where ``nn`` is
the number of the type. If the resource record type is not supported the number of the type. If the resource record type is not supported
in BIND 9, the result will be displayed as described in :rfc:`3597`. in BIND 9, the result is displayed as described in :rfc:`3597`.
**-u** ``-u``
Print query times in microseconds instead of milliseconds. This option indicates that print query times should be provided in microseconds instead of milliseconds.
**-v** ``-v``
Print the version number and exit. This option prints the version number and exits.
**-x** addr ``-x addr``
Simplified reverse lookups, for mapping addresses to names. The This option sets simplified reverse lookups, for mapping addresses to names. The
``addr`` is an IPv4 address in dotted-decimal notation, or a ``addr`` is an IPv4 address in dotted-decimal notation, or a
colon-delimited IPv6 address. When the ``-x`` is used, there is no colon-delimited IPv6 address. When the ``-x`` option is used, there is no
need to provide the ``name``, ``class`` and ``type`` arguments. need to provide the ``name``, ``class``, and ``type`` arguments.
``dig`` automatically performs a lookup for a name like ``dig`` automatically performs a lookup for a name like
``94.2.0.192.in-addr.arpa`` and sets the query type and class to PTR ``94.2.0.192.in-addr.arpa`` and sets the query type and class to PTR
and IN respectively. IPv6 addresses are looked up using nibble format and IN respectively. IPv6 addresses are looked up using nibble format
under the IP6.ARPA domain. under the IP6.ARPA domain.
**-y** [hmac:]keyname:secret ``-y [hmac:]keyname:secret``
Sign queries using TSIG with the given authentication key. This option signs queries using TSIG with the given authentication key.
``keyname`` is the name of the key, and ``secret`` is the base64 ``keyname`` is the name of the key, and ``secret`` is the
encoded shared secret. ``hmac`` is the name of the key algorithm; base64-encoded shared secret. ``hmac`` is the name of the key algorithm;
valid choices are ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``, valid choices are ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``,
``hmac-sha256``, ``hmac-sha384``, or ``hmac-sha512``. If ``hmac`` is ``hmac-sha256``, ``hmac-sha384``, or ``hmac-sha512``. If ``hmac`` is
not specified, the default is ``hmac-md5`` or if MD5 was disabled not specified, the default is ``hmac-md5``; if MD5 was disabled, the default is
``hmac-sha256``. ``hmac-sha256``.
.. note:: You should use the ``-k`` option and avoid the ``-y`` option, .. note:: Only the ``-k`` option should be used, rather than the ``-y`` option,
because with ``-y`` the shared secret is supplied as a command line because with ``-y`` the shared secret is supplied as a command-line
argument in clear text. This may be visible in the output from ps1 or argument in clear text. This may be visible in the output from ``ps1`` or
in a history file maintained by the user's shell. in a history file maintained by the user's shell.
Query Options Query Options
@@ -206,297 +206,296 @@ answer get printed, and others determine the timeout and retry
strategies. strategies.
Each query option is identified by a keyword preceded by a plus sign Each query option is identified by a keyword preceded by a plus sign
(``+``). Some keywords set or reset an option. These may be preceded by (``+``). Some keywords set or reset an option; these may be preceded by
the string ``no`` to negate the meaning of that keyword. Other keywords the string ``no`` to negate the meaning of that keyword. Other keywords
assign values to options like the timeout interval. They have the form assign values to options, like the timeout interval. They have the form
``+keyword=value``. Keywords may be abbreviated, provided the ``+keyword=value``. Keywords may be abbreviated, provided the
abbreviation is unambiguous; for example, ``+cd`` is equivalent to abbreviation is unambiguous; for example, ``+cd`` is equivalent to
``+cdflag``. The query options are: ``+cdflag``. The query options are:
``+[no]aaflag`` ``+[no]aaflag``
A synonym for ``+[no]aaonly``. This option is a synonym for ``+[no]aaonly``.
``+[no]aaonly`` ``+[no]aaonly``
Sets the "aa" flag in the query. This option sets the ``aa`` flag in the query.
``+[no]additional`` ``+[no]additional``
Display [do not display] the additional section of a reply. The This option displays [or does not display] the additional section of a reply. The
default is to display it. default is to display it.
``+[no]adflag`` ``+[no]adflag``
Set [do not set] the AD (authentic data) bit in the query. This This option sets [or does not set] the AD (authentic data) bit in the query. This
requests the server to return whether all of the answer and authority requests the server to return whether all of the answer and authority
sections have all been validated as secure according to the security sections have been validated as secure, according to the security
policy of the server. AD=1 indicates that all records have been policy of the server. ``AD=1`` indicates that all records have been
validated as secure and the answer is not from a OPT-OUT range. AD=0 validated as secure and the answer is not from a OPT-OUT range. ``AD=0``
indicate that some part of the answer was insecure or not validated. indicates that some part of the answer was insecure or not validated.
This bit is set by default. This bit is set by default.
``+[no]all`` ``+[no]all``
Set or clear all display flags. This option sets or clears all display flags.
``+[no]answer`` ``+[no]answer``
Display [do not display] the answer section of a reply. The default This option displays [or does not display] the answer section of a reply. The default
is to display it. is to display it.
``+[no]authority`` ``+[no]authority``
Display [do not display] the authority section of a reply. The This option displays [or does not display] the authority section of a reply. The
default is to display it. default is to display it.
``+[no]badcookie`` ``+[no]badcookie``
Retry lookup with the new server cookie if a BADCOOKIE response is This option retries the lookup with a new server cookie if a BADCOOKIE response is
received. received.
``+[no]besteffort`` ``+[no]besteffort``
Attempt to display the contents of messages which are malformed. The This option attempts to display the contents of messages which are malformed. The
default is to not display malformed answers. default is to not display malformed answers.
``+bufsize=B`` ``+bufsize=B``
Set the UDP message buffer size advertised using EDNS0 to ``B`` This option sets the UDP message buffer size advertised using EDNS0 to ``B``
bytes. The maximum and minimum sizes of this buffer are 65535 and 0 bytes. The maximum and minimum sizes of this buffer are 65535 and 0,
respectively. Values outside this range are rounded up or down respectively. Values outside this range are rounded up or down
appropriately. Values other than zero will cause a EDNS query to be appropriately. Values other than zero cause an EDNS query to be
sent. sent.
``+[no]cdflag`` ``+[no]cdflag``
Set [do not set] the CD (checking disabled) bit in the query. This This option sets [or does not set] the CD (checking disabled) bit in the query. This
requests the server to not perform DNSSEC validation of responses. requests the server to not perform DNSSEC validation of responses.
``+[no]class`` ``+[no]class``
Display [do not display] the CLASS when printing the record. This option displays [or does not display] the CLASS when printing the record.
``+[no]cmd`` ``+[no]cmd``
Toggles the printing of the initial comment in the output, identifying the This option toggles the printing of the initial comment in the output, identifying the
version of ``dig`` and the query options that have been applied. This option version of ``dig`` and the query options that have been applied. This option
always has global effect; it cannot be set globally and then overridden on a always has a global effect; it cannot be set globally and then overridden on a
per-lookup basis. The default is to print this comment. per-lookup basis. The default is to print this comment.
``+[no]comments`` ``+[no]comments``
Toggles the display of some comment lines in the output, containing This option toggles the display of some comment lines in the output, with
information about the packet header and OPT pseudosection, and the names of information about the packet header and OPT pseudosection, and the names of
the response section. The default is to print these comments. the response section. The default is to print these comments.
Other types of comments in the output are not affected by this option, but Other types of comments in the output are not affected by this option, but
can be controlled using other command line switches. These include can be controlled using other command-line switches. These include
``+[no]cmd``, ``+[no]question``, ``+[no]stats``, and ``+[no]rrcomments``. ``+[no]cmd``, ``+[no]question``, ``+[no]stats``, and ``+[no]rrcomments``.
``+[no]cookie=####`` ``+[no]cookie=####``
Send a COOKIE EDNS option, with optional value. Replaying a COOKIE This option sends [or does not send] a COOKIE EDNS option, with an optional value. Replaying a COOKIE
from a previous response will allow the server to identify a previous from a previous response allows the server to identify a previous
client. The default is ``+cookie``. client. The default is ``+cookie``.
``+cookie`` is also set when +trace is set to better emulate the ``+cookie`` is also set when ``+trace`` is set to better emulate the
default queries from a nameserver. default queries from a nameserver.
``+[no]crypto`` ``+[no]crypto``
Toggle the display of cryptographic fields in DNSSEC records. The This option toggles the display of cryptographic fields in DNSSEC records. The
contents of these field are unnecessary to debug most DNSSEC contents of these fields are unnecessary for debugging most DNSSEC
validation failures and removing them makes it easier to see the validation failures and removing them makes it easier to see the
common failures. The default is to display the fields. When omitted common failures. The default is to display the fields. When omitted,
they are replaced by the string "[omitted]" or in the DNSKEY case the they are replaced by the string ``[omitted]`` or, in the DNSKEY case, the
key id is displayed as the replacement, e.g. "[ key id = value ]". key ID is displayed as the replacement, e.g. ``[ key id = value ]``.
``+[no]defname`` ``+[no]defname``
Deprecated, treated as a synonym for ``+[no]search`` This option, which is deprecated, is treated as a synonym for ``+[no]search``.
``+[no]dnssec`` ``+[no]dnssec``
Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in This option requests that DNSSEC records be sent by setting the DNSSEC OK (DO) bit in
the OPT record in the additional section of the query. the OPT record in the additional section of the query.
``+domain=somename`` ``+domain=somename``
Set the search list to contain the single domain ``somename``, as if This option sets the search list to contain the single domain ``somename``, as if
specified in a ``domain`` directive in ``/etc/resolv.conf``, and specified in a ``domain`` directive in ``/etc/resolv.conf``, and
enable search list processing as if the ``+search`` option were enables search list processing as if the ``+search`` option were
given. given.
``+dscp=value`` ``+dscp=value``
Set the DSCP code point to be used when sending the query. Valid DSCP This option sets the DSCP code point to be used when sending the query. Valid DSCP
code points are in the range [0..63]. By default no code point is code points are in the range [0...63]. By default no code point is
explicitly set. explicitly set.
``+[no]edns[=#]`` ``+[no]edns[=#]``
Specify the EDNS version to query with. Valid values are 0 to 255. This option specifies the EDNS version to query with. Valid values are 0 to 255.
Setting the EDNS version will cause a EDNS query to be sent. Setting the EDNS version causes an EDNS query to be sent.
``+noedns`` clears the remembered EDNS version. EDNS is set to 0 by ``+noedns`` clears the remembered EDNS version. EDNS is set to 0 by
default. default.
``+[no]ednsflags[=#]`` ``+[no]ednsflags[=#]``
Set the must-be-zero EDNS flags bits (Z bits) to the specified value. This option sets the must-be-zero EDNS flags bits (Z bits) to the specified value.
Decimal, hex and octal encodings are accepted. Setting a named flag Decimal, hex, and octal encodings are accepted. Setting a named flag
(e.g. DO) will silently be ignored. By default, no Z bits are set. (e.g., DO) is silently ignored. By default, no Z bits are set.
``+[no]ednsnegotiation`` ``+[no]ednsnegotiation``
Enable / disable EDNS version negotiation. By default EDNS version This option enables/disables EDNS version negotiation. By default, EDNS version
negotiation is enabled. negotiation is enabled.
``+[no]ednsopt[=code[:value]]`` ``+[no]ednsopt[=code[:value]]``
Specify EDNS option with code point ``code`` and optionally payload This option specifies the EDNS option with code point ``code`` and an optional payload
of ``value`` as a hexadecimal string. ``code`` can be either an EDNS of ``value`` as a hexadecimal string. ``code`` can be either an EDNS
option name (for example, ``NSID`` or ``ECS``), or an arbitrary option name (for example, ``NSID`` or ``ECS``) or an arbitrary
numeric value. ``+noednsopt`` clears the EDNS options to be sent. numeric value. ``+noednsopt`` clears the EDNS options to be sent.
``+[no]expire`` ``+[no]expire``
Send an EDNS Expire option. This option sends an EDNS Expire option.
``+[no]fail`` ``+[no]fail``
Do not try the next server if you receive a SERVFAIL. The default is This option indicates that ``named`` should try [or not try] the next server if a SERVFAIL is received. The default is
to not try the next server which is the reverse of normal stub to not try the next server, which is the reverse of normal stub
resolver behavior. resolver behavior.
``+[no]header-only`` ``+[no]header-only``
Send a query with a DNS header without a question section. The This option sends a query with a DNS header without a question section. The
default is to add a question section. The query type and query name default is to add a question section. The query type and query name
are ignored when this is set. are ignored when this is set.
``+[no]identify`` ``+[no]identify``
Show [or do not show] the IP address and port number that supplied This option shows [or does not show] the IP address and port number that supplied
the answer when the ``+short`` option is enabled. If short form the answer, when the ``+short`` option is enabled. If short form
answers are requested, the default is not to show the source address answers are requested, the default is not to show the source address
and port number of the server that provided the answer. and port number of the server that provided the answer.
``+[no]idnin`` ``+[no]idnin``
Process [do not process] IDN domain names on input. This requires IDN This option processes [or does not process] IDN domain names on input. This requires
SUPPORT to have been enabled at compile time. ``IDN SUPPORT`` to have been enabled at compile time.
The default is to process IDN input when standard output is a tty. The default is to process IDN input when standard output is a tty.
The IDN processing on input is disabled when dig output is redirected The IDN processing on input is disabled when ``dig`` output is redirected
to files, pipes, and other non-tty file descriptors. to files, pipes, and other non-tty file descriptors.
``+[no]idnout`` ``+[no]idnout``
Convert [do not convert] puny code on output. This requires IDN This option converts [or does not convert] puny code on output. This requires
SUPPORT to have been enabled at compile time. ``IDN SUPPORT`` to have been enabled at compile time.
The default is to process puny code on output when standard output is The default is to process puny code on output when standard output is
a tty. The puny code processing on output is disabled when dig output a tty. The puny code processing on output is disabled when ``dig`` output
is redirected to files, pipes, and other non-tty file descriptors. is redirected to files, pipes, and other non-tty file descriptors.
``+[no]ignore`` ``+[no]ignore``
Ignore truncation in UDP responses instead of retrying with TCP. By This option ignores [or does not ignore] truncation in UDP responses instead of retrying with TCP. By
default, TCP retries are performed. default, TCP retries are performed.
``+[no]keepalive`` ``+[no]keepalive``
Send [or do not send] an EDNS Keepalive option. This option sends [or does not send] an EDNS Keepalive option.
``+[no]keepopen`` ``+[no]keepopen``
Keep the TCP socket open between queries and reuse it rather than This option keeps [or does not keep] the TCP socket open between queries, and reuses it rather than
creating a new TCP socket for each lookup. The default is creating a new TCP socket for each lookup. The default is
``+nokeepopen``. ``+nokeepopen``.
``+[no]mapped`` ``+[no]mapped``
Allow mapped IPv4 over IPv6 addresses to be used. The default is This option allows [or does not allow] mapped IPv4-over-IPv6 addresses to be used. The default is
``+mapped``. ``+mapped``.
``+[no]multiline`` ``+[no]multiline``
Print records like the SOA records in a verbose multi-line format This option prints [or does not print] records, like the SOA records, in a verbose multi-line format
with human-readable comments. The default is to print each record on with human-readable comments. The default is to print each record on
a single line, to facilitate machine parsing of the ``dig`` output. a single line to facilitate machine parsing of the ``dig`` output.
``+ndots=D`` ``+ndots=D``
Set the number of dots that have to appear in ``name`` to ``D`` for This option sets the number of dots (``D``) that must appear in ``name`` for
it to be considered absolute. The default value is that defined using it to be considered absolute. The default value is that defined using
the ndots statement in ``/etc/resolv.conf``, or 1 if no ndots the ``ndots`` statement in ``/etc/resolv.conf``, or 1 if no ``ndots``
statement is present. Names with fewer dots are interpreted as statement is present. Names with fewer dots are interpreted as
relative names and will be searched for in the domains listed in the relative names, and are searched for in the domains listed in the
``search`` or ``domain`` directive in ``/etc/resolv.conf`` if ``search`` or ``domain`` directive in ``/etc/resolv.conf`` if
``+search`` is set. ``+search`` is set.
``+[no]nsid`` ``+[no]nsid``
Include an EDNS name server ID request when sending a query. When enabled, this option includes an EDNS name server ID request when sending a query.
``+[no]nssearch`` ``+[no]nssearch``
When this option is set, ``dig`` attempts to find the authoritative When this option is set, ``dig`` attempts to find the authoritative
name servers for the zone containing the name being looked up and name servers for the zone containing the name being looked up, and
display the SOA record that each name server has for the zone. display the SOA record that each name server has for the zone.
Addresses of servers that that did not respond are also printed. Addresses of servers that did not respond are also printed.
``+[no]onesoa`` ``+[no]onesoa``
Print only one (starting) SOA record when performing an AXFR. The When enabled, this option prints only one (starting) SOA record when performing an AXFR. The
default is to print both the starting and ending SOA records. default is to print both the starting and ending SOA records.
``+[no]opcode=value`` ``+[no]opcode=value``
Set [restore] the DNS message opcode to the specified value. The When enabled, this option sets (restores) the DNS message opcode to the specified value. The
default value is QUERY (0). default value is QUERY (0).
``+padding=value`` ``+padding=value``
Pad the size of the query packet using the EDNS Padding option to This option pads the size of the query packet using the EDNS Padding option to
blocks of ``value`` bytes. For example, ``+padding=32`` would cause a blocks of ``value`` bytes. For example, ``+padding=32`` causes a
48-byte query to be padded to 64 bytes. The default block size is 0, 48-byte query to be padded to 64 bytes. The default block size is 0,
which disables padding. The maximum is 512. Values are ordinarily which disables padding; the maximum is 512. Values are ordinarily
expected to be powers of two, such as 128; however, this is not expected to be powers of two, such as 128; however, this is not
mandatory. Responses to padded queries may also be padded, but only mandatory. Responses to padded queries may also be padded, but only
if the query uses TCP or DNS COOKIE. if the query uses TCP or DNS COOKIE.
``+qid=value`` ``+qid=value``
This option specifies the query ID to use when sending queries.
Specify the query ID to use when sending queries.
``+[no]qr`` ``+[no]qr``
Toggles the display of the query message as it is sent. By default, the query This option toggles the display of the query message as it is sent. By default, the query
is not printed. is not printed.
``+[no]question`` ``+[no]question``
Toggles the display of the question section of a query when an answer is This option toggles the display of the question section of a query when an answer is
returned. The default is to print the question section as a comment. returned. The default is to print the question section as a comment.
``+[no]raflag`` ``+[no]raflag``
Set [do not set] the RA (Recursion Available) bit in the query. The This option sets [or does not set] the RA (Recursion Available) bit in the query. The
default is +noraflag. This bit should be ignored by the server for default is ``+noraflag``. This bit is ignored by the server for
QUERY. QUERY.
``+[no]rdflag`` ``+[no]rdflag``
A synonym for ``+[no]recurse``. This option is a synonym for ``+[no]recurse``.
``+[no]recurse`` ``+[no]recurse``
Toggle the setting of the RD (recursion desired) bit in the query. This option toggles the setting of the RD (recursion desired) bit in the query.
This bit is set by default, which means ``dig`` normally sends This bit is set by default, which means ``dig`` normally sends
recursive queries. Recursion is automatically disabled when the recursive queries. Recursion is automatically disabled when the
``+nssearch`` or ``+trace`` query options are used. ``+nssearch`` or ``+trace`` query option is used.
``+retry=T`` ``+retry=T``
Sets the number of times to retry UDP queries to server to ``T`` This option sets the number of times to retry UDP queries to server to ``T``
instead of the default, 2. Unlike ``+tries``, this does not include instead of the default, 2. Unlike ``+tries``, this does not include
the initial query. the initial query.
``+[no]rrcomments`` ``+[no]rrcomments``
Toggle the display of per-record comments in the output (for example, This option toggles the display of per-record comments in the output (for example,
human-readable key information about DNSKEY records). The default is human-readable key information about DNSKEY records). The default is
not to print record comments unless multiline mode is active. not to print record comments unless multiline mode is active.
``+[no]search`` ``+[no]search``
Use [do not use] the search list defined by the searchlist or domain This option uses [or does not use] the search list defined by the searchlist or domain
directive in ``resolv.conf`` (if any). The search list is not used by directive in ``resolv.conf``, if any. The search list is not used by
default. default.
'ndots' from ``resolv.conf`` (default 1) which may be overridden by ``ndots`` from ``resolv.conf`` (default 1), which may be overridden by
``+ndots`` determines if the name will be treated as relative or not ``+ndots``, determines whether the name is treated as relative
and hence whether a search is eventually performed or not. and hence whether a search is eventually performed.
``+[no]short`` ``+[no]short``
Provide a terse answer. The default is to print the answer in a verbose This option toggles whether a terse answer is provided. The default is to print the answer in a verbose
form. This option always has global effect; it cannot be set globally and form. This option always has a global effect; it cannot be set globally and
then overridden on a per-lookup basis. then overridden on a per-lookup basis.
``+[no]showsearch`` ``+[no]showsearch``
Perform [do not perform] a search showing intermediate results. This option performs [or does not perform] a search showing intermediate results.
``+[no]sigchase`` ``+[no]sigchase``
This feature is now obsolete and has been removed; use ``delv`` This feature is now obsolete and has been removed; use ``delv``
instead. instead.
``+split=W`` ``+split=W``
Split long hex- or base64-formatted fields in resource records into This option splits long hex- or base64-formatted fields in resource records into
chunks of ``W`` characters (where ``W`` is rounded up to the nearest chunks of ``W`` characters (where ``W`` is rounded up to the nearest
multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be
split at all. The default is 56 characters, or 44 characters when split at all. The default is 56 characters, or 44 characters when
multiline mode is active. multiline mode is active.
``+[no]stats`` ``+[no]stats``
Toggles the printing of statistics: when the query was made, the size of the This option toggles the printing of statistics: when the query was made, the size of the
reply and so on. The default behavior is to print the query statistics as a reply, etc. The default behavior is to print the query statistics as a
comment after each lookup. comment after each lookup.
``+[no]subnet=addr[/prefix-length]`` ``+[no]subnet=addr[/prefix-length]``
Send (don't send) an EDNS Client Subnet option with the specified IP This option sends [or does not send] an EDNS CLIENT-SUBNET option with the specified IP
address or network prefix. address or network prefix.
``dig +subnet=0.0.0.0/0``, or simply ``dig +subnet=0`` for short, ``dig +subnet=0.0.0.0/0``, or simply ``dig +subnet=0`` for short,
@@ -505,75 +504,74 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to
address information must *not* be used when resolving this query. address information must *not* be used when resolving this query.
``+[no]tcflag`` ``+[no]tcflag``
Set [do not set] the TC (TrunCation) bit in the query. The default is This option sets [or does not set] the TC (TrunCation) bit in the query. The default is
+notcflag. This bit should be ignored by the server for QUERY. ``+notcflag``. This bit is ignored by the server for QUERY.
``+[no]tcp`` ``+[no]tcp``
Use [do not use] TCP when querying name servers. The default behavior This option uses [or does not use] TCP when querying name servers. The default behavior
is to use UDP unless a type ``any`` or ``ixfr=N`` query is requested, is to use UDP unless a type ``any`` or ``ixfr=N`` query is requested,
in which case the default is TCP. AXFR queries always use TCP. in which case the default is TCP. AXFR queries always use TCP.
``+timeout=T`` ``+timeout=T``
Sets the timeout for a query to ``T`` seconds. The default timeout is This option sets the timeout for a query to ``T`` seconds. The default timeout is
5 seconds. An attempt to set ``T`` to less than 1 will result in a 5 seconds. An attempt to set ``T`` to less than 1 is silently set to 1.
query timeout of 1 second being applied.
``+[no]topdown`` ``+[no]topdown``
This feature is related to ``dig +sigchase``, which is obsolete and This feature is related to ``dig +sigchase``, which is obsolete and
has been removed. Use ``delv`` instead. has been removed. Use ``delv`` instead.
``+[no]trace`` ``+[no]trace``
Toggle tracing of the delegation path from the root name servers for This option toggles tracing of the delegation path from the root name servers for
the name being looked up. Tracing is disabled by default. When the name being looked up. Tracing is disabled by default. When
tracing is enabled, ``dig`` makes iterative queries to resolve the tracing is enabled, ``dig`` makes iterative queries to resolve the
name being looked up. It will follow referrals from the root servers, name being looked up. It follows referrals from the root servers,
showing the answer from each server that was used to resolve the showing the answer from each server that was used to resolve the
lookup. lookup.
If @server is also specified, it affects only the initial query for If ``@server`` is also specified, it affects only the initial query for
the root zone name servers. the root zone name servers.
``+dnssec`` is also set when +trace is set to better emulate the ``+dnssec`` is also set when ``+trace`` is set, to better emulate the
default queries from a nameserver. default queries from a name server.
``+tries=T`` ``+tries=T``
Sets the number of times to try UDP queries to server to ``T`` This option sets the number of times to try UDP queries to server to ``T``
instead of the default, 3. If ``T`` is less than or equal to zero, instead of the default, 3. If ``T`` is less than or equal to zero,
the number of tries is silently rounded up to 1. the number of tries is silently rounded up to 1.
``+trusted-key=####`` ``+trusted-key=####``
Formerly specified trusted keys for use with ``dig +sigchase``. This This option formerly specified trusted keys for use with ``dig +sigchase``. This
feature is now obsolete and has been removed; use ``delv`` instead. feature is now obsolete and has been removed; use ``delv`` instead.
``+[no]ttlid`` ``+[no]ttlid``
Display [do not display] the TTL when printing the record. This option displays [or does not display] the TTL when printing the record.
``+[no]ttlunits`` ``+[no]ttlunits``
Display [do not display] the TTL in friendly human-readable time This option displays [or does not display] the TTL in friendly human-readable time
units of "s", "m", "h", "d", and "w", representing seconds, minutes, units of ``s``, ``m``, ``h``, ``d``, and ``w``, representing seconds, minutes,
hours, days and weeks. Implies +ttlid. hours, days, and weeks. This implies ``+ttlid``.
``+[no]unexpected`` ``+[no]unexpected``
Accept [do not accept] answers from unexpected sources. By default, ``dig`` This option accepts [or does not accept] answers from unexpected sources. By default, ``dig``
won't accept a reply from a source other than the one to which it sent the will not accept a reply from a source other than the one to which it sent the
query. query.
``+[no]unknownformat`` ``+[no]unknownformat``
Print all RDATA in unknown RR type presentation format (:rfc:`3597`). This option prints all RDATA in unknown RR type presentation format (:rfc:`3597`).
The default is to print RDATA for known types in the type's The default is to print RDATA for known types in the type's
presentation format. presentation format.
``+[no]vc`` ``+[no]vc``
Use [do not use] TCP when querying name servers. This alternate This option uses [or does not use] TCP when querying name servers. This alternate
syntax to ``+[no]tcp`` is provided for backwards compatibility. The syntax to ``+[no]tcp`` is provided for backwards compatibility. The
"vc" stands for "virtual circuit". ``vc`` stands for "virtual circuit."
``+[no]yaml`` ``+[no]yaml``
Print the responses (and, if <option>+qr</option> is in use, also the When enabled, this option prints the responses (and, if ``+qr`` is in use, also the
outgoing queries) in a detailed YAML format. outgoing queries) in a detailed YAML format.
``+[no]zflag`` ``+[no]zflag``
Set [do not set] the last unassigned DNS header flag in a DNS query. This option sets [or does not set] the last unassigned DNS header flag in a DNS query.
This flag is off by default. This flag is off by default.
Multiple Queries Multiple Queries
@@ -582,12 +580,12 @@ Multiple Queries
The BIND 9 implementation of ``dig`` supports specifying multiple The BIND 9 implementation of ``dig`` supports specifying multiple
queries on the command line (in addition to supporting the ``-f`` batch queries on the command line (in addition to supporting the ``-f`` batch
file option). Each of those queries can be supplied with its own set of file option). Each of those queries can be supplied with its own set of
flags, options and query options. flags, options, and query options.
In this case, each ``query`` argument represent an individual query in In this case, each ``query`` argument represents an individual query in
the command-line syntax described above. Each consists of any of the the command-line syntax described above. Each consists of any of the
standard options and flags, the name to be looked up, an optional query standard options and flags, the name to be looked up, an optional query
type and class and any query options that should be applied to that type and class, and any query options that should be applied to that
query. query.
A global set of query options, which should be applied to all queries, A global set of query options, which should be applied to all queries,
@@ -601,12 +599,12 @@ query options. For example:
dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr
shows how ``dig`` could be used from the command line to make three shows how ``dig`` can be used from the command line to make three
lookups: an ANY query for ``www.isc.org``, a reverse lookup of 127.0.0.1 lookups: an ANY query for ``www.isc.org``, a reverse lookup of 127.0.0.1,
and a query for the NS records of ``isc.org``. A global query option of and a query for the NS records of ``isc.org``. A global query option of
``+qr`` is applied, so that ``dig`` shows the initial query it made for ``+qr`` is applied, so that ``dig`` shows the initial query it made for
each lookup. The final query has a local query option of ``+noqr`` which each lookup. The final query has a local query option of ``+noqr`` which
means that ``dig`` will not print the initial query when it looks up the means that ``dig`` does not print the initial query when it looks up the
NS records for ``isc.org``. NS records for ``isc.org``.
IDN Support IDN Support
@@ -614,10 +612,10 @@ IDN Support
If ``dig`` has been built with IDN (internationalized domain name) If ``dig`` has been built with IDN (internationalized domain name)
support, it can accept and display non-ASCII domain names. ``dig`` support, it can accept and display non-ASCII domain names. ``dig``
appropriately converts character encoding of domain name before sending appropriately converts character encoding of a domain name before sending
a request to DNS server or displaying a reply from the server. If you'd a request to a DNS server or displaying a reply from the server.
like to turn off the IDN support for some reason, use parameters To turn off IDN support, use the parameters
``+noidnin`` and ``+noidnout`` or define the IDN_DISABLE environment ``+noidnin`` and ``+noidnout``, or define the ``IDN_DISABLE`` environment
variable. variable.
Files Files

134
bin/dig/host.rst
View File

@@ -36,12 +36,12 @@ Description
``host`` is a simple utility for performing DNS lookups. It is normally ``host`` is a simple utility for performing DNS lookups. It is normally
used to convert names to IP addresses and vice versa. When no arguments used to convert names to IP addresses and vice versa. When no arguments
or options are given, ``host`` prints a short summary of its command or options are given, ``host`` prints a short summary of its
line arguments and options. command-line arguments and options.
``name`` is the domain name that is to be looked up. It can also be a ``name`` is the domain name that is to be looked up. It can also be a
dotted-decimal IPv4 address or a colon-delimited IPv6 address, in which dotted-decimal IPv4 address or a colon-delimited IPv6 address, in which
case ``host`` will by default perform a reverse lookup for that address. case ``host`` by default performs a reverse lookup for that address.
``server`` is an optional argument which is either the name or IP ``server`` is an optional argument which is either the name or IP
address of the name server that ``host`` should query instead of the address of the name server that ``host`` should query instead of the
server or servers listed in ``/etc/resolv.conf``. server or servers listed in ``/etc/resolv.conf``.
@@ -49,111 +49,111 @@ server or servers listed in ``/etc/resolv.conf``.
Options Options
~~~~~~~ ~~~~~~~
**-4** ``-4``
Use IPv4 only for query transport. See also the ``-6`` option. This option specifies that only IPv4 should be used for query transport. See also the ``-6`` option.
**-6** ``-6``
Use IPv6 only for query transport. See also the ``-4`` option. This option specifies that only IPv6 should be used for query transport. See also the ``-4`` option.
**-a** ``-a``
"All". The ``-a`` option is normally equivalent to ``-v -t ANY``. It The ``-a`` ("all") option is normally equivalent to ``-v -t ANY``. It
also affects the behaviour of the ``-l`` list zone option. also affects the behavior of the ``-l`` list zone option.
**-A** ``-A``
"Almost all". The ``-A`` option is equivalent to ``-a`` except RRSIG, The ``-A`` ("almost all") option is equivalent to ``-a``, except that RRSIG,
NSEC, and NSEC3 records are omitted from the output. NSEC, and NSEC3 records are omitted from the output.
**-c** class ``-c class``
Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) This option specifies the query class, which can be used to lookup HS (Hesiod) or CH (Chaosnet)
class resource records. The default class is IN (Internet). class resource records. The default class is IN (Internet).
**-C** ``-C``
Check consistency: ``host`` will query the SOA records for zone This option indicates that ``named`` should check consistency, meaning that ``host`` queries the SOA records for zone
``name`` from all the listed authoritative name servers for that ``name`` from all the listed authoritative name servers for that
zone. The list of name servers is defined by the NS records that are zone. The list of name servers is defined by the NS records that are
found for the zone. found for the zone.
**-d** ``-d``
Print debugging traces. Equivalent to the ``-v`` verbose option. This option prints debugging traces, and is equivalent to the ``-v`` verbose option.
**-l** ``-l``
List zone: The ``host`` command performs a zone transfer of zone This option tells ``named` to list the zone, meaning the ``host`` command performs a zone transfer of zone
``name`` and prints out the NS, PTR and address records (A/AAAA). ``name`` and prints out the NS, PTR, and address records (A/AAAA).
Together, the ``-l -a`` options print all records in the zone. Together, the ``-l -a`` options print all records in the zone.
**-N** ndots ``-N ndots``
The number of dots that have to be in ``name`` for it to be This option specifies the number of dots (``ndots``) that have to be in ``name`` for it to be
considered absolute. The default value is that defined using the considered absolute. The default value is that defined using the
ndots statement in ``/etc/resolv.conf``, or 1 if no ndots statement ``ndots`` statement in ``/etc/resolv.conf``, or 1 if no ``ndots`` statement
is present. Names with fewer dots are interpreted as relative names is present. Names with fewer dots are interpreted as relative names,
and will be searched for in the domains listed in the ``search`` or and are searched for in the domains listed in the ``search`` or
``domain`` directive in ``/etc/resolv.conf``. ``domain`` directive in ``/etc/resolv.conf``.
**-p** port ``-p port``
Specify the port on the server to query. The default is 53. This option specifies the port to query on the server. The default is 53.
**-r** ``-r``
Non-recursive query: Setting this option clears the RD (recursion This option specifies a non-recursive query; setting this option clears the RD (recursion
desired) bit in the query. This should mean that the name server desired) bit in the query. This means that the name server
receiving the query will not attempt to resolve ``name``. The ``-r`` receiving the query does not attempt to resolve ``name``. The ``-r``
option enables ``host`` to mimic the behavior of a name server by option enables ``host`` to mimic the behavior of a name server by
making non-recursive queries and expecting to receive answers to making non-recursive queries, and expecting to receive answers to
those queries that can be referrals to other name servers. those queries that can be referrals to other name servers.
**-R** number ``-R number``
Number of retries for UDP queries: If ``number`` is negative or zero, This option specifies the number of retries for UDP queries. If ``number`` is negative or zero,
the number of retries will default to 1. The default value is 1, or the number of retries is silently set to 1. The default value is 1, or
the value of the ``attempts`` option in ``/etc/resolv.conf``, if set. the value of the ``attempts`` option in ``/etc/resolv.conf``, if set.
**-s** ``-s``
Do *not* send the query to the next nameserver if any server responds This option tells ``named`` *not* to send the query to the next nameserver if any server responds
with a SERVFAIL response, which is the reverse of normal stub with a SERVFAIL response, which is the reverse of normal stub
resolver behavior. resolver behavior.
**-t** type ``-t type``
Query type: The ``type`` argument can be any recognized query type: This option specifies the query type. The ``type`` argument can be any recognized query type:
CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc. CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc.
When no query type is specified, ``host`` automatically selects an When no query type is specified, ``host`` automatically selects an
appropriate query type. By default, it looks for A, AAAA, and MX appropriate query type. By default, it looks for A, AAAA, and MX
records. If the ``-C`` option is given, queries will be made for SOA records. If the ``-C`` option is given, queries are made for SOA
records. If ``name`` is a dotted-decimal IPv4 address or records. If ``name`` is a dotted-decimal IPv4 address or
colon-delimited IPv6 address, ``host`` will query for PTR records. colon-delimited IPv6 address, ``host`` queries for PTR records.
If a query type of IXFR is chosen the starting serial number can be If a query type of IXFR is chosen, the starting serial number can be
specified by appending an equal followed by the starting serial specified by appending an equals sign (=), followed by the starting serial
number (like ``-t IXFR=12345678``). number, e.g., ``-t IXFR=12345678``.
**-T**; **-U** ``-T``; ``-U``
TCP/UDP: By default, ``host`` uses UDP when making queries. The This option specifies TCP or UDP. By default, ``host`` uses UDP when making queries; the
``-T`` option makes it use a TCP connection when querying the name ``-T`` option makes it use a TCP connection when querying the name
server. TCP will be automatically selected for queries that require server. TCP is automatically selected for queries that require
it, such as zone transfer (AXFR) requests. Type ANY queries default it, such as zone transfer (AXFR) requests. Type ``ANY`` queries default
to TCP but can be forced to UDP initially using ``-U``. to TCP, but can be forced to use UDP initially via ``-U``.
**-m** flag ``-m flag``
Memory usage debugging: the flag can be ``record``, ``usage``, or This option sets memory usage debugging: the flag can be ``record``, ``usage``, or
``trace``. You can specify the ``-m`` option more than once to set ``trace``. The ``-m`` option can be specified more than once to set
multiple flags. multiple flags.
**-v** ``-v``
Verbose output. Equivalent to the ``-d`` debug option. Verbose output This option sets verbose output, and is equivalent to the ``-d`` debug option. Verbose output
can also be enabled by setting the ``debug`` option in can also be enabled by setting the ``debug`` option in
``/etc/resolv.conf``. ``/etc/resolv.conf``.
**-V** ``-V``
Print the version number and exit. This option prints the version number and exits.
**-w** ``-w``
Wait forever: The query timeout is set to the maximum possible. See This option sets "wait forever": the query timeout is set to the maximum possible. See
also the ``-W`` option. also the ``-W`` option.
**-W** wait ``-W wait``
Timeout: Wait for up to ``wait`` seconds for a reply. If ``wait`` is This options sets the length of the wait timeout, indicating that ``named`` should wait for up to ``wait`` seconds for a reply. If ``wait`` is
less than one, the wait interval is set to one second. less than 1, the wait interval is set to 1 second.
By default, ``host`` will wait for 5 seconds for UDP responses and 10 By default, ``host`` waits for 5 seconds for UDP responses and 10
seconds for TCP connections. These defaults can be overridden by the seconds for TCP connections. These defaults can be overridden by the
``timeout`` option in ``/etc/resolv.conf``. ``timeout`` option in ``/etc/resolv.conf``.
@@ -164,10 +164,10 @@ IDN Support
If ``host`` has been built with IDN (internationalized domain name) If ``host`` has been built with IDN (internationalized domain name)
support, it can accept and display non-ASCII domain names. ``host`` support, it can accept and display non-ASCII domain names. ``host``
appropriately converts character encoding of domain name before sending appropriately converts character encoding of a domain name before sending
a request to DNS server or displaying a reply from the server. If you'd a request to a DNS server or displaying a reply from the server.
like to turn off the IDN support for some reason, define the IDN_DISABLE To turn off IDN support, define the ``IDN_DISABLE``
environment variable. The IDN support is disabled if the variable is set environment variable. IDN support is disabled if the variable is set
when ``host`` runs. when ``host`` runs.
Files Files

146
bin/dig/nslookup.rst
View File

@@ -34,11 +34,11 @@ Synopsis
Description Description
~~~~~~~~~~~ ~~~~~~~~~~~
``Nslookup`` is a program to query Internet domain name servers. ``nslookup`` is a program to query Internet domain name servers.
``Nslookup`` has two modes: interactive and non-interactive. Interactive ``nslookup`` has two modes: interactive and non-interactive. Interactive
mode allows the user to query name servers for information about various mode allows the user to query name servers for information about various
hosts and domains or to print a list of hosts in a domain. 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 Non-interactive mode prints just the name and requested
information for a host or domain. information for a host or domain.
Arguments Arguments
@@ -46,7 +46,7 @@ Arguments
Interactive mode is entered in the following cases: Interactive mode is entered in the following cases:
a. when no arguments are given (the default name server will be used) a. when no arguments are given (the default name server is used);
b. when the first argument is a hyphen (-) and the second argument is b. when the first argument is a hyphen (-) and the second argument is
the host name or Internet address of a name server. the host name or Internet address of a name server.
@@ -57,7 +57,7 @@ argument specifies the host name or address of a name server.
Options can also be specified on the command line if they precede the Options can also be specified on the command line if they precede the
arguments and are prefixed with a hyphen. For example, to change the arguments and are prefixed with a hyphen. For example, to change the
default query type to host information, and the initial timeout to 10 default query type to host information, with an initial timeout of 10
seconds, type: seconds, type:
:: ::
@@ -65,59 +65,59 @@ seconds, type:
nslookup -query=hinfo -timeout=10 nslookup -query=hinfo -timeout=10
The ``-version`` option causes ``nslookup`` to print the version number The ``-version`` option causes ``nslookup`` to print the version number
and immediately exits. and immediately exit.
Interactive Commands Interactive Commands
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
``host`` [server] ``host [server]``
Look up information for host using the current default server or This command looks up information for ``host`` using the current default server or
using server, if specified. If host is an Internet address and the using ``server``, if specified. If ``host`` is an Internet address and the
query type is A or PTR, the name of the host is returned. If host is query type is A or PTR, the name of the host is returned. If ``host`` is
a name and does not have a trailing period, the search list is used a name and does not have a trailing period (``.``), the search list is used
to qualify the name. to qualify the name.
To look up a host not in the current domain, append a period to the To look up a host not in the current domain, append a period to the
name. name.
``server`` domain | ``lserver`` domain ``server domain`` | ``lserver domain``
Change the default server to domain; ``lserver`` uses the initial These commands change the default server to ``domain``; ``lserver`` uses the initial
server to look up information about domain, while ``server`` uses the server to look up information about ``domain``, while ``server`` uses the
current default server. If an authoritative answer can't be found, current default server. If an authoritative answer cannot be found,
the names of servers that might have the answer are returned. the names of servers that might have the answer are returned.
``root`` ``root``
not implemented This command is not implemented.
``finger`` ``finger``
not implemented This command is not implemented.
``ls`` ``ls``
not implemented This command is not implemented.
``view`` ``view``
not implemented This command is not implemented.
``help`` ``help``
not implemented This command is not implemented.
``?`` ``?``
not implemented This command is not implemented.
``exit`` ``exit``
Exits the program. This command exits the program.
``set`` keyword[=value] ``set keyword[=value]``
This command is used to change state information that affects the This command is used to change state information that affects the
lookups. Valid keywords are: lookups. Valid keywords are:
``all`` ``all``
Prints the current values of the frequently used options to This keyword prints the current values of the frequently used options to
``set``. Information about the current default server and host is ``set``. Information about the current default server and host is
also printed. also printed.
``class=``\ value ``class=value``
Change the query class to one of: This keyword changes the query class to one of:
``IN`` ``IN``
the Internet class the Internet class
@@ -131,72 +131,62 @@ Interactive Commands
``ANY`` ``ANY``
wildcard wildcard
The class specifies the protocol group of the information. The class specifies the protocol group of the information. The default
is ``IN``; the abbreviation for this keyword is ``cl``.
(Default = IN; abbreviation = cl)
``nodebug`` ``nodebug``
Turn on or off the display of the full response packet and any This keyword turns on or off the display of the full response packet, and any
intermediate response packets when searching. intermediate response packets, when searching. The default for this keyword is
``nodebug``; the abbreviation for this keyword is ``[no]deb``.
(Default = nodebug; abbreviation = [no]deb)
``nod2`` ``nod2``
Turn debugging mode on or off. This displays more about what This keyword turns debugging mode on or off. This displays more about what
nslookup is doing. nslookup is doing. The default is ``nod2``.
(Default = nod2) ``domain=name``
This keyword sets the search list to ``name``.
``domain=``\ name
Sets the search list to name.
``nosearch`` ``nosearch``
If the lookup request contains at least one period but doesn't end If the lookup request contains at least one period, but does not end
with a trailing period, append the domain names in the domain with a trailing period, this keyword appends the domain names in the domain
search list to the request until an answer is received. search list to the request until an answer is received. The default is ``search``.
(Default = search) ``port=value``
This keyword changes the default TCP/UDP name server port to ``value`` from
its default, port 53. The abbreviation for this keyword is ``po``.
``port=``\ value ``querytype=value`` | ``type=value``
Change the default TCP/UDP name server port to value. This keyword changes the type of the information query to ``value``. The
defaults are A and then AAAA; the abbreviations for these keywords are
``q`` and ``ty``.
(Default = 53; abbreviation = po) Please note that it is only possible to specify one query type. Only the default
behavior looks up both when an alternative is not specified.
``querytype=``\ value | ``type=``\ value
Change the type of the information query.
(Default = A and then AAAA; abbreviations = q, ty)
**Note:** It is only possible to specify one query type, only the default
behavior looks up both when an alternative is not specified.
``norecurse`` ``norecurse``
Tell the name server to query other servers if it does not have This keyword tells the name server to query other servers if it does not have
the information. the information. The default is ``recurse``; the abbreviation for this
keyword is ``[no]rec``.
(Default = recurse; abbreviation = [no]rec) ``ndots=number``
This keyword sets the number of dots (label separators) in a domain that
disables searching. Absolute names always stop searching.
``ndots=``\ number ``retry=number``
Set the number of dots (label separators) in a domain that will This keyword sets the number of retries to ``number``.
disable searching. Absolute names always stop searching.
``retry=``\ number ``timeout=number``
Set the number of retries to number. This keyword changes the initial timeout interval to wait for a reply to
``number``, in seconds.
``timeout=``\ number
Change the initial timeout interval for waiting for a reply to
number seconds.
``novc`` ``novc``
Always use a virtual circuit when sending requests to the server. This keyword indicates that a virtual circuit should always be used when sending requests to the server.
``novc`` is the default.
(Default = novc)
``nofail`` ``nofail``
Try the next nameserver if a nameserver responds with SERVFAIL or This keyword tries the next nameserver if a nameserver responds with SERVFAIL or
a referral (nofail) or terminate query (fail) on such a response. a referral (nofail), or terminates the query (fail) on such a response. The
default is ``nofail``.
(Default = nofail)
Return Values Return Values
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@@ -209,11 +199,11 @@ IDN Support
If ``nslookup`` has been built with IDN (internationalized domain name) If ``nslookup`` has been built with IDN (internationalized domain name)
support, it can accept and display non-ASCII domain names. ``nslookup`` support, it can accept and display non-ASCII domain names. ``nslookup``
appropriately converts character encoding of domain name before sending appropriately converts character encoding of a domain name before sending
a request to DNS server or displaying a reply from the server. If you'd a request to a DNS server or displaying a reply from the server.
like to turn off the IDN support for some reason, define the IDN_DISABLE To turn off IDN support, define the ``IDN_DISABLE``
environment variable. The IDN support is disabled if the variable is set environment variable. IDN support is disabled if the variable is set
when ``nslookup`` runs or when the standard output is not a tty. when ``nslookup`` runs, or when the standard output is not a tty.
Files Files
~~~~~ ~~~~~

76
bin/dnssec/dnssec-dsfromkey.rst
View File

@@ -45,7 +45,7 @@ The ``dnssec-dsfromkey`` command outputs DS (Delegation Signer) resource records
The input keys can be specified in a number of ways: The input keys can be specified in a number of ways:
By default, ``dnssec-dsfromkey`` reads a key file named like By default, ``dnssec-dsfromkey`` reads a key file named in the format
``Knnnn.+aaa+iiiii.key``, as generated by ``dnssec-keygen``. ``Knnnn.+aaa+iiiii.key``, as generated by ``dnssec-keygen``.
With the ``-f file`` option, ``dnssec-dsfromkey`` reads keys from a zone With the ``-f file`` option, ``dnssec-dsfromkey`` reads keys from a zone
@@ -57,73 +57,73 @@ as generated by ``dnssec-keygen`` ``-C``.
Options Options
~~~~~~~ ~~~~~~~
**-1** ``-1``
An abbreviation for ``-a SHA1`` This option is an abbreviation for ``-a SHA1``.
**-2** ``-2``
An abbreviation for ``-a SHA-256`` This option is an abbreviation for ``-a SHA-256``.
**-a** algorithm ``-a algorithm``
Specify a digest algorithm to use when converting DNSKEY records to This option specifies a digest algorithm to use when converting DNSKEY records to
DS records. This option can be repeated, so that multiple DS records DS records. This option can be repeated, so that multiple DS records
are created for each DNSKEY record. are created for each DNSKEY record.
The algorithm must be one of SHA-1, SHA-256, or SHA-384. These values The algorithm must be one of SHA-1, SHA-256, or SHA-384. These values
are case insensitive, and the hyphen may be omitted. If no algorithm are case-insensitive, and the hyphen may be omitted. If no algorithm
is specified, the default is SHA-256. is specified, the default is SHA-256.
**-A** ``-A``
Include ZSKs when generating DS records. Without this option, only This option indicates that ZSKs are to be included when generating DS records. Without this option, only
keys which have the KSK flag set will be converted to DS records and keys which have the KSK flag set are converted to DS records and
printed. Useful only in ``-f`` zone file mode. printed. This option is only useful in ``-f`` zone file mode.
**-c** class ``-c class``
Specifies the DNS class (default is IN). Useful only in ``-s`` keyset This option specifies the DNS class; the default is IN. This option is only useful in ``-s`` keyset
or ``-f`` zone file mode. or ``-f`` zone file mode.
**-C** ``-C``
Generate CDS records rather than DS records. This option generates CDS records rather than DS records.
**-f** file ``-f file``
Zone file mode: ``dnssec-dsfromkey``'s final dnsname argument is the This option sets zone file mode, in which the final dnsname argument of ``dnssec-dsfromkey`` is the
DNS domain name of a zone whose master file can be read from DNS domain name of a zone whose master file can be read from
``file``. If the zone name is the same as ``file``, then it may be ``file``. If the zone name is the same as ``file``, then it may be
omitted. omitted.
If file is ``"-"``, then the zone data is read from the standard If ``file`` is ``-``, then the zone data is read from the standard
input. This makes it possible to use the output of the ``dig`` input. This makes it possible to use the output of the ``dig``
command as input, as in: command as input, as in:
``dig dnskey example.com | dnssec-dsfromkey -f - example.com`` ``dig dnskey example.com | dnssec-dsfromkey -f - example.com``
**-h** ``-h``
Prints usage information. This option prints usage information.
**-K** directory ``-K directory``
Look for key files or ``keyset-`` files in ``directory``. This option tells BIND 9 to look for key files or ``keyset-`` files in ``directory``.
**-s** ``-s``
Keyset mode: ``dnssec-dsfromkey``'s final dnsname argument is the DNS This option enables keyset mode, in which the final dnsname argument from ``dnssec-dsfromkey`` is the DNS
domain name used to locate a ``keyset-`` file. domain name used to locate a ``keyset-`` file.
**-T** TTL ``-T TTL``
Specifies the TTL of the DS records. By default the TTL is omitted. This option specifies the TTL of the DS records. By default the TTL is omitted.
**-v** level ``-v level``
Sets the debugging level. This option sets the debugging level.
**-V** ``-V``
Prints version information. This option prints version information.
Example Example
~~~~~~~ ~~~~~~~
To build the SHA-256 DS RR from the ``Kexample.com.+003+26160`` keyfile To build the SHA-256 DS RR from the ``Kexample.com.+003+26160`` keyfile,
name, you can issue the following command: issue the following command:
``dnssec-dsfromkey -2 Kexample.com.+003+26160`` ``dnssec-dsfromkey -2 Kexample.com.+003+26160``
The command would print something like: The command returns something similar to:
``example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94`` ``example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94``
@@ -131,16 +131,16 @@ Files
~~~~~ ~~~~~
The keyfile can be designated by the key identification The keyfile can be designated by the key identification
``Knnnn.+aaa+iiiii`` or the full file name ``Knnnn.+aaa+iiiii.key`` as ``Knnnn.+aaa+iiiii`` or the full file name ``Knnnn.+aaa+iiiii.key``, as
generated by dnssec-keygen8. generated by ``dnssec-keygen``.
The keyset file name is built from the ``directory``, the string The keyset file name is built from the ``directory``, the string
``keyset-`` and the ``dnsname``. ``keyset-``, and the ``dnsname``.
Caveat Caveat
~~~~~~ ~~~~~~
A keyfile error can give a "file not found" even if the file exists. A keyfile error may return "file not found," even if the file exists.
See Also See Also
~~~~~~~~ ~~~~~~~~

74
bin/dnssec/dnssec-importkey.rst
View File

@@ -38,11 +38,11 @@ Description
``dnssec-importkey`` reads a public DNSKEY record and generates a pair ``dnssec-importkey`` reads a public DNSKEY record and generates a pair
of .key/.private files. The DNSKEY record may be read from an existing of .key/.private files. The DNSKEY record may be read from an existing
.key file, in which case a corresponding .private file will be .key file, in which case a corresponding .private file is
generated, or it may be read from any other file or from the standard generated, or it may be read from any other file or from the standard
input, in which case both .key and .private files will be generated. input, in which case both .key and .private files are generated.
The newly-created .private file does *not* contain private key data, and The newly created .private file does *not* contain private key data, and
cannot be used for signing. However, having a .private file makes it cannot be used for signing. However, having a .private file makes it
possible to set publication (``-P``) and deletion (``-D``) times for the possible to set publication (``-P``) and deletion (``-D``) times for the
key, which means the public key can be added to and removed from the key, which means the public key can be added to and removed from the
@@ -51,70 +51,70 @@ DNSKEY RRset on schedule even if the true private key is stored offline.
Options Options
~~~~~~~ ~~~~~~~
**-f** filename ``-f filename``
Zone file mode: instead of a public keyfile name, the argument is the This option indicates the zone file mode. Instead of a public keyfile name, the argument is the
DNS domain name of a zone master file, which can be read from DNS domain name of a zone master file, which can be read from
``file``. If the domain name is the same as ``file``, then it may be ``filename``. If the domain name is the same as ``filename``, then it may be
omitted. omitted.
If ``file`` is set to ``"-"``, then the zone data is read from the If ``filename`` is set to ``"-"``, then the zone data is read from the
standard input. standard input.
**-K** directory ``-K directory``
Sets the directory in which the key files are to reside. This option sets the directory in which the key files are to reside.
**-L** ttl ``-L ttl``
Sets the default TTL to use for this key when it is converted into a This option sets the default TTL to use for this key when it is converted into a
DNSKEY RR. If the key is imported into a zone, this is the TTL that DNSKEY RR. This is the TTL used when the key is imported into a zone,
will be used for it, unless there was already a DNSKEY RRset in unless there was already a DNSKEY RRset in
place, in which case the existing TTL would take precedence. Setting place, in which case the existing TTL takes precedence. Setting the default TTL to ``0`` or ``none``
the default TTL to ``0`` or ``none`` removes it. removes it from the key.
**-h** ``-h``
Emit usage message and exit. This option emits a usage message and exits.
**-v** level ``-v level``
Sets the debugging level. This option sets the debugging level.
**-V** ``-V``
Prints version information. This option prints version information.
Timing Options Timing Options
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
argument begins with a '+' or '-', it is interpreted as an offset from argument begins with a ``+`` or ``-``, it is interpreted as an offset from
the present time. For convenience, if such an offset is followed by one the present time. For convenience, if such an offset is followed by one
of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is of the suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, then the offset is
computed in years (defined as 365 24-hour days, ignoring leap years), computed in years (defined as 365 24-hour days, ignoring leap years),
months (defined as 30 24-hour days), weeks, days, hours, or minutes, months (defined as 30 24-hour days), weeks, days, hours, or minutes,
respectively. Without a suffix, the offset is computed in seconds. To respectively. Without a suffix, the offset is computed in seconds. To
explicitly prevent a date from being set, use 'none' or 'never'. explicitly prevent a date from being set, use ``none`` or ``never``.
**-P** date/offset ``-P date/offset``
Sets the date on which a key is to be published to the zone. After This option sets the date on which a key is to be published to the zone. After
that date, the key will be included in the zone but will not be used that date, the key is included in the zone but is not used
to sign it. to sign it.
**-P** sync date/offset ``-P sync date/offset``
Sets the date on which CDS and CDNSKEY records that match this key This option sets the date on which CDS and CDNSKEY records that match this key
are to be published to the zone. are to be published to the zone.
**-D** date/offset ``-D date/offset``
Sets the date on which the key is to be deleted. After that date, the This option sets the date on which the key is to be deleted. After that date, the
key will no longer be included in the zone. (It may remain in the key key is no longer included in the zone. (However, it may remain in the key
repository, however.) repository.)
**-D** sync date/offset ``-D sync date/offset``
Sets the date on which the CDS and CDNSKEY records that match this This option sets the date on which the CDS and CDNSKEY records that match this
key are to be deleted. key are to be deleted.
Files Files
~~~~~ ~~~~~
A keyfile can be designed by the key identification ``Knnnn.+aaa+iiiii`` A keyfile can be designed by the key identification ``Knnnn.+aaa+iiiii``
or the full file name ``Knnnn.+aaa+iiiii.key`` as generated by or the full file name ``Knnnn.+aaa+iiiii.key``, as generated by
dnssec-keygen8. ``dnssec-keygen``.
See Also See Also
~~~~~~~~ ~~~~~~~~

2
bin/dnssec/dnssec-keyfromlabel.rst
View File

@@ -104,7 +104,7 @@ Options
operations without any need for an operator to manually enter a PIN. operations without any need for an operator to manually enter a PIN.
Note: Making the HSM's PIN accessible in this manner may reduce the Note: Making the HSM's PIN accessible in this manner may reduce the
security advantage of using an HSM; use caution security advantage of using an HSM; use caution
when using this feature. with this feature.
``-n nametype`` ``-n nametype``
This option specifies the owner type of the key. The value of ``nametype`` must This option specifies the owner type of the key. The value of ``nametype`` must

2
bin/dnssec/dnssec-keygen.rst
View File

@@ -94,7 +94,7 @@ Options
This option indicates that the DNS record containing the key should have the This option indicates that the DNS record containing the key should have the
specified class. If not specified, class IN is used. specified class. If not specified, class IN is used.
``-d`` bits ``-d bits``
This option specifies the key size in bits. For the algorithms RSASHA1, NSEC3RSASA1, RSASHA256, and This option specifies the key size in bits. For the algorithms RSASHA1, NSEC3RSASA1, RSASHA256, and
RSASHA512 the key size must be between 1024 and 4096 bits; DH size is between 128 RSASHA512 the key size must be between 1024 and 4096 bits; DH size is between 128
and 4096 bits. This option is ignored for algorithms ECDSAP256SHA256, and 4096 bits. This option is ignored for algorithms ECDSAP256SHA256,

174
bin/dnssec/dnssec-settime.rst
View File

@@ -40,7 +40,7 @@ timing metadata as specified by the ``-P``, ``-A``, ``-R``, ``-I``, and
other signing software to determine when a key is to be published, other signing software to determine when a key is to be published,
whether it should be used for signing a zone, etc. whether it should be used for signing a zone, etc.
If none of these options is set on the command line, then If none of these options is set on the command line,
``dnssec-settime`` simply prints the key timing metadata already stored ``dnssec-settime`` simply prints the key timing metadata already stored
in the key. in the key.
@@ -54,155 +54,157 @@ the key file. The private file's permissions are always set to be
inaccessible to anyone other than the owner (mode 0600). inaccessible to anyone other than the owner (mode 0600).
When working with state files, it is possible to update the timing metadata in When working with state files, it is possible to update the timing metadata in
those files as well with ``-s``. If this option is used you can also update key those files as well with ``-s``. With this option, it is also possible to update key
states with ``-d`` (DS), ``-k`` (DNSKEY), ``-r`` (RRSIG of KSK), or ``-z`` states with ``-d`` (DS), ``-k`` (DNSKEY), ``-r`` (RRSIG of KSK), or ``-z``
(RRSIG of ZSK). Allowed states are HIDDEN, RUMOURED, OMNIPRESENT, and (RRSIG of ZSK). Allowed states are HIDDEN, RUMOURED, OMNIPRESENT, and
UNRETENTIVE. UNRETENTIVE.
You can also set the goal state of the key with ``-g``. This should be either The goal state of the key can also be set with ``-g``. This should be either
HIDDEN or OMNIPRESENT (representing whether the key should be removed from the HIDDEN or OMNIPRESENT, representing whether the key should be removed from the
zone, or published). zone or published.
It is NOT RECOMMENDED to manipulate state files manually except for testing It is NOT RECOMMENDED to manipulate state files manually, except for testing
purposes. purposes.
Options Options
~~~~~~~ ~~~~~~~
**-f** ``-f``
Force an update of an old-format key with no metadata fields. Without This option forces an update of an old-format key with no metadata fields. Without
this option, ``dnssec-settime`` will fail when attempting to update a this option, ``dnssec-settime`` fails when attempting to update a
legacy key. With this option, the key will be recreated in the new legacy key. With this option, the key is recreated in the new
format, but with the original key data retained. The key's creation format, but with the original key data retained. The key's creation
date will be set to the present time. If no other values are date is set to the present time. If no other values are
specified, then the key's publication and activation dates will also specified, then the key's publication and activation dates are also
be set to the present time. set to the present time.
**-K** directory ``-K directory``
Sets the directory in which the key files are to reside. This option sets the directory in which the key files are to reside.
**-L** ttl ``-L ttl``
Sets the default TTL to use for this key when it is converted into a This option sets the default TTL to use for this key when it is converted into a
DNSKEY RR. If the key is imported into a zone, this is the TTL that DNSKEY RR. This is the TTL used when the key is imported into a zone,
will be used for it, unless there was already a DNSKEY RRset in unless there was already a DNSKEY RRset in
place, in which case the existing TTL would take precedence. If this place, in which case the existing TTL takes precedence. If this
value is not set and there is no existing DNSKEY RRset, the TTL will value is not set and there is no existing DNSKEY RRset, the TTL
default to the SOA TTL. Setting the default TTL to ``0`` or ``none`` defaults to the SOA TTL. Setting the default TTL to ``0`` or ``none``
removes it from the key. removes it from the key.
**-h** ``-h``
Emit usage message and exit. This option emits a usage message and exits.
**-V** ``-V``
Prints version information. This option prints version information.
**-v** level ``-v level``
Sets the debugging level. This option sets the debugging level.
**-E** engine ``-E engine``
Specifies the cryptographic hardware to use, when applicable. This option specifies the cryptographic hardware to use, when applicable.
When BIND is built with OpenSSL PKCS#11 support, this defaults to the When BIND is built with OpenSSL PKCS#11 support, this defaults to the
string "pkcs11", which identifies an OpenSSL engine that can drive a string ``pkcs11``, which identifies an OpenSSL engine that can drive a
cryptographic accelerator or hardware service module. When BIND is cryptographic accelerator or hardware service module. When BIND is
built with native PKCS#11 cryptography (--enable-native-pkcs11), it built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it
defaults to the path of the PKCS#11 provider library specified via defaults to the path of the PKCS#11 provider library specified via
"--with-pkcs11". ``--with-pkcs11``.
Timing Options Timing Options
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
argument begins with a '+' or '-', it is interpreted as an offset from argument begins with a ``+`` or ``-``, it is interpreted as an offset from
the present time. For convenience, if such an offset is followed by one the present time. For convenience, if such an offset is followed by one
of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is of the suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, then the offset is
computed in years (defined as 365 24-hour days, ignoring leap years), computed in years (defined as 365 24-hour days, ignoring leap years),
months (defined as 30 24-hour days), weeks, days, hours, or minutes, months (defined as 30 24-hour days), weeks, days, hours, or minutes,
respectively. Without a suffix, the offset is computed in seconds. To respectively. Without a suffix, the offset is computed in seconds. To
unset a date, use 'none' or 'never'. explicitly prevent a date from being set, use ``none`` or ``never``.
**-P** date/offset ``-P date/offset``
Sets the date on which a key is to be published to the zone. After This option sets the date on which a key is to be published to the zone. After
that date, the key will be included in the zone but will not be used that date, the key is included in the zone but is not used
to sign it. to sign it.
**-P** sync date/offset ``-P sync date/offset``
Sets the date on which CDS and CDNSKEY records that match this key This option sets the date on which CDS and CDNSKEY records that match this key
are to be published to the zone. are to be published to the zone.
**-A** date/offset ``-A date/offset``
Sets the date on which the key is to be activated. After that date, This option sets the date on which the key is to be activated. After that date,
the key will be included in the zone and used to sign it. the key is included in the zone and used to sign it.
**-R** date/offset ``-R date/offset``
Sets the date on which the key is to be revoked. After that date, the This option sets the date on which the key is to be revoked. After that date, the
key will be flagged as revoked. It will be included in the zone and key is flagged as revoked. It is included in the zone and
will be used to sign it. is used to sign it.
**-I** date/offset ``-I date/offset``
Sets the date on which the key is to be retired. After that date, the This option sets the date on which the key is to be retired. After that date, the
key will still be included in the zone, but it will not be used to key is still included in the zone, but it is not used to
sign it. sign it.
**-D** date/offset ``-D date/offset``
Sets the date on which the key is to be deleted. After that date, the This option sets the date on which the key is to be deleted. After that date, the
key will no longer be included in the zone. (It may remain in the key key is no longer included in the zone. (However, it may remain in the key
repository, however.) repository.)
**-D** sync date/offset ``-D sync date/offset``
Sets the date on which the CDS and CDNSKEY records that match this This option sets the date on which the CDS and CDNSKEY records that match this
key are to be deleted. key are to be deleted.
**-S** predecessor key ``-S predecessor key``
Select a key for which the key being modified will be an explicit This option selects a key for which the key being modified is an explicit
successor. The name, algorithm, size, and type of the predecessor key successor. The name, algorithm, size, and type of the predecessor key
must exactly match those of the key being modified. The activation must exactly match those of the key being modified. The activation
date of the successor key will be set to the inactivation date of the date of the successor key is set to the inactivation date of the
predecessor. The publication date will be set to the activation date predecessor. The publication date is set to the activation date
minus the prepublication interval, which defaults to 30 days. minus the prepublication interval, which defaults to 30 days.
**-i** interval ``-i interval``
Sets the prepublication interval for a key. If set, then the This option sets the prepublication interval for a key. If set, then the
publication and activation dates must be separated by at least this publication and activation dates must be separated by at least this
much time. If the activation date is specified but the publication much time. If the activation date is specified but the publication
date isn't, then the publication date will default to this much time date is not, the publication date defaults to this much time
before the activation date; conversely, if the publication date is before the activation date; conversely, if the publication date is
specified but activation date isn't, then activation will be set to specified but not the activation date, activation is set to
this much time after publication. this much time after publication.
If the key is being set to be an explicit successor to another key, If the key is being created as an explicit successor to another key,
then the default prepublication interval is 30 days; otherwise it is then the default prepublication interval is 30 days; otherwise it is
zero. zero.
As with date offsets, if the argument is followed by one of the As with date offsets, if the argument is followed by one of the
suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, the interval is
measured in years, months, weeks, days, hours, or minutes, measured in years, months, weeks, days, hours, or minutes,
respectively. Without a suffix, the interval is measured in seconds. respectively. Without a suffix, the interval is measured in seconds.
Key State Options Key State Options
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Known key states are HIDDEN, RUMOURED, OMNIPRESENT and UNRETENTIVE. These should To test dnssec-policy it may be necessary to construct keys with artificial
not be set manually except for testing purposes. state information; these options are used by the testing framework for that
purpose, but should never be used in production.
Known key states are HIDDEN, RUMOURED, OMNIPRESENT, and UNRETENTIVE.
``-s`` ``-s``
When setting key timing data, also update the state file. This option indicates that when setting key timing data, the state file should also be updated.
``-g`` ``-g state``
Set the goal state for this key. Must be HIDDEN or OMNIPRESENT. This option sets the goal state for this key. Must be HIDDEN or OMNIPRESENT.
``-d`` ``-d state date/offset``
Set the DS state for this key, and when it was last changed. This option sets the DS state for this key as of the specified date, offset from the current date.
``-k`` ``-k state date/offset``
Set the DNSKEY state for this key, and when it was last changed. This option sets the DNSKEY state for this key as of the specified date, offset from the current date.
``-r`` ``-r state date/offset``
Set the RRSIG (KSK) state for this key, and when it was last changed. This option sets the RRSIG (KSK) state for this key as of the specified date, offset from the current date.
``-z`` ``-z state date/offset``
This option sets the RRSIG (ZSK) state for this key as of the specified date, offset from the current date.
Set the RRSIG (ZSK) state for this key, and when it was last changed.
Printing Options Printing Options
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@@ -210,18 +212,18 @@ Printing Options
``dnssec-settime`` can also be used to print the timing metadata ``dnssec-settime`` can also be used to print the timing metadata
associated with a key. associated with a key.
**-u** ``-u``
Print times in UNIX epoch format. This option indicates that times should be printed in Unix epoch format.
**-p** C/P/Psync/A/R/I/D/Dsync/all ``-p C/P/Psync/A/R/I/D/Dsync/all``
Print a specific metadata value or set of metadata values. The ``-p`` This option prints a specific metadata value or set of metadata values. The ``-p``
option may be followed by one or more of the following letters or option may be followed by one or more of the following letters or
strings to indicate which value or values to print: ``C`` for the strings to indicate which value or values to print: ``C`` for the
creation date, ``P`` for the publication date, ``Psync`` for the CDS creation date, ``P`` for the publication date, ``Psync`` for the CDS
and CDNSKEY publication date, ``A`` for the activation date, ``R`` and CDNSKEY publication date, ``A`` for the activation date, ``R``
for the revocation date, ``I`` for the inactivation date, ``D`` for for the revocation date, ``I`` for the inactivation date, ``D`` for
the deletion date, and ``Dsync`` for the CDS and CDNSKEY deletion the deletion date, and ``Dsync`` for the CDS and CDNSKEY deletion
date To print all of the metadata, use ``-p all``. date. To print all of the metadata, use ``all``.
See Also See Also
~~~~~~~~ ~~~~~~~~

333
bin/dnssec/dnssec-signzone.rst
View File

@@ -34,233 +34,232 @@ Synopsis
Description Description
~~~~~~~~~~~ ~~~~~~~~~~~
``dnssec-signzone`` signs a zone. It generates NSEC and RRSIG records ``dnssec-signzone`` signs a zone; it generates NSEC and RRSIG records
and produces a signed version of the zone. The security status of and produces a signed version of the zone. The security status of
delegations from the signed zone (that is, whether the child zones are delegations from the signed zone (that is, whether the child zones are
secure or not) is determined by the presence or absence of a ``keyset`` secure) is determined by the presence or absence of a ``keyset``
file for each child zone. file for each child zone.
Options Options
~~~~~~~ ~~~~~~~
**-a** ``-a``
Verify all generated signatures. This option verifies all generated signatures.
**-c** class ``-c class``
Specifies the DNS class of the zone. This option specifies the DNS class of the zone.
**-C** ``-C``
Compatibility mode: Generate a ``keyset-zonename`` file in addition This option sets compatibility mode, in which a ``keyset-zonename`` file is generated in addition
to ``dsset-zonename`` when signing a zone, for use by older versions to ``dsset-zonename`` when signing a zone, for use by older versions
of ``dnssec-signzone``. of ``dnssec-signzone``.
**-d** directory ``-d directory``
Look for ``dsset-`` or ``keyset-`` files in ``directory``. This option indicates the directory where BIND 9 should look for ``dsset-`` or ``keyset-`` files.
**-D** ``-D``
Output only those record types automatically managed by This option indicates that only those record types automatically managed by
``dnssec-signzone``, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. ``dnssec-signzone``, i.e., RRSIG, NSEC, NSEC3 and NSEC3PARAM records, should be included in the output.
If smart signing (``-S``) is used, DNSKEY records are also included. If smart signing (``-S``) is used, DNSKEY records are also included.
The resulting file can be included in the original zone file with The resulting file can be included in the original zone file with
``$INCLUDE``. This option cannot be combined with ``-O raw``, ``$INCLUDE``. This option cannot be combined with ``-O raw``,
``-O map``, or serial number updating. ``-O map``, or serial-number updating.
**-E** engine ``-E engine``
When applicable, specifies the hardware to use for cryptographic This option specifies the hardware to use for cryptographic
operations, such as a secure key store used for signing. operations, such as a secure key store used for signing, when applicable.
When BIND is built with OpenSSL PKCS#11 support, this defaults to the When BIND is built with OpenSSL PKCS#11 support, this defaults to the
string "pkcs11", which identifies an OpenSSL engine that can drive a string ``pkcs11``, which identifies an OpenSSL engine that can drive a
cryptographic accelerator or hardware service module. When BIND is cryptographic accelerator or hardware service module. When BIND is
built with native PKCS#11 cryptography (--enable-native-pkcs11), it built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it
defaults to the path of the PKCS#11 provider library specified via defaults to the path of the PKCS#11 provider library specified via
"--with-pkcs11". ``--with-pkcs11``.
**-g** ``-g``
Generate DS records for child zones from ``dsset-`` or ``keyset-`` This option indicates that DS records for child zones should be generated from a ``dsset-`` or ``keyset-``
file. Existing DS records will be removed. file. Existing DS records are removed.
**-K** directory ``-K directory``
Key repository: Specify a directory to search for DNSSEC keys. If not This option specifies the directory to search for DNSSEC keys. If not
specified, defaults to the current directory. specified, it defaults to the current directory.
**-k** key ``-k key``
Treat specified key as a key signing key ignoring any key flags. This This option tells BIND 9 to treat the specified key as a key-signing key, ignoring any key flags. This
option may be specified multiple times. option may be specified multiple times.
**-M** maxttl ``-M maxttl``
Sets the maximum TTL for the signed zone. Any TTL higher than maxttl This option sets the maximum TTL for the signed zone. Any TTL higher than ``maxttl``
in the input zone will be reduced to maxttl in the output. This in the input zone is reduced to ``maxttl`` in the output. This
provides certainty as to the largest possible TTL in the signed zone, provides certainty as to the largest possible TTL in the signed zone,
which is useful to know when rolling keys because it is the longest which is useful to know when rolling keys. The maxttl is the longest
possible time before signatures that have been retrieved by resolvers possible time before signatures that have been retrieved by resolvers
will expire from resolver caches. Zones that are signed with this expire from resolver caches. Zones that are signed with this
option should be configured to use a matching ``max-zone-ttl`` in option should be configured to use a matching ``max-zone-ttl`` in
``named.conf``. (Note: This option is incompatible with ``-D``, ``named.conf``. (Note: This option is incompatible with ``-D``,
because it modifies non-DNSSEC data in the output zone.) because it modifies non-DNSSEC data in the output zone.)
**-s** start-time ``-s start-time``
Specify the date and time when the generated RRSIG records become This option specifies the date and time when the generated RRSIG records become
valid. This can be either an absolute or relative time. An absolute valid. This can be either an absolute or relative time. An absolute
start time is indicated by a number in YYYYMMDDHHMMSS notation; start time is indicated by a number in YYYYMMDDHHMMSS notation;
20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative
start time is indicated by +N, which is N seconds from the current start time is indicated by ``+N``, which is N seconds from the current
time. If no ``start-time`` is specified, the current time minus 1 time. If no ``start-time`` is specified, the current time minus 1
hour (to allow for clock skew) is used. hour (to allow for clock skew) is used.
**-e** end-time ``-e end-time``
Specify the date and time when the generated RRSIG records expire. As This option specifies the date and time when the generated RRSIG records expire. As
with ``start-time``, an absolute time is indicated in YYYYMMDDHHMMSS with ``start-time``, an absolute time is indicated in YYYYMMDDHHMMSS
notation. A time relative to the start time is indicated with +N, notation. A time relative to the start time is indicated with ``+N``,
which is N seconds from the start time. A time relative to the which is N seconds from the start time. A time relative to the
current time is indicated with now+N. If no ``end-time`` is current time is indicated with ``now+N``. If no ``end-time`` is
specified, 30 days from the start time is used as a default. specified, 30 days from the start time is the default.
``end-time`` must be later than ``start-time``. ``end-time`` must be later than ``start-time``.
**-X** extended end-time ``-X extended end-time``
Specify the date and time when the generated RRSIG records for the This option specifies the date and time when the generated RRSIG records for the
DNSKEY RRset will expire. This is to be used in cases when the DNSKEY DNSKEY RRset expire. This is to be used in cases when the DNSKEY
signatures need to persist longer than signatures on other records; signatures need to persist longer than signatures on other records;
e.g., when the private component of the KSK is kept offline and the e.g., when the private component of the KSK is kept offline and the
KSK signature is to be refreshed manually. KSK signature is to be refreshed manually.
As with ``start-time``, an absolute time is indicated in As with ``end-time``, an absolute time is indicated in
YYYYMMDDHHMMSS notation. A time relative to the start time is YYYYMMDDHHMMSS notation. A time relative to the start time is
indicated with +N, which is N seconds from the start time. A time indicated with ``+N``, which is N seconds from the start time. A time
relative to the current time is indicated with now+N. If no relative to the current time is indicated with ``now+N``. If no
``extended end-time`` is specified, the value of ``end-time`` is used ``extended end-time`` is specified, the value of ``end-time`` is used
as the default. (``end-time``, in turn, defaults to 30 days from the as the default. (``end-time``, in turn, defaults to 30 days from the
start time.) ``extended end-time`` must be later than ``start-time``. start time.) ``extended end-time`` must be later than ``start-time``.
**-f** output-file ``-f output-file``
The name of the output file containing the signed zone. The default This option indicates the name of the output file containing the signed zone. The default
is to append ``.signed`` to the input filename. If ``output-file`` is is to append ``.signed`` to the input filename. If ``output-file`` is
set to ``"-"``, then the signed zone is written to the standard set to ``-``, then the signed zone is written to the standard
output, with a default output format of "full". output, with a default output format of ``full``.
**-h** ``-h``
Prints a short summary of the options and arguments to This option prints a short summary of the options and arguments to
``dnssec-signzone``. ``dnssec-signzone``.
**-V** ``-V``
Prints version information. This option prints version information.
**-i** interval ``-i interval``
When a previously-signed zone is passed as input, records may be This option indicates that, when a previously signed zone is passed as input, records may be
resigned. The ``interval`` option specifies the cycle interval as an re-signed. The ``interval`` option specifies the cycle interval as an
offset from the current time (in seconds). If a RRSIG record expires offset from the current time, in seconds. If a RRSIG record expires
after the cycle interval, it is retained. Otherwise, it is considered after the cycle interval, it is retained; otherwise, it is considered
to be expiring soon, and it will be replaced. to be expiring soon and it is replaced.
The default cycle interval is one quarter of the difference between The default cycle interval is one quarter of the difference between
the signature end and start times. So if neither ``end-time`` or the signature end and start times. So if neither ``end-time`` nor
``start-time`` are specified, ``dnssec-signzone`` generates ``start-time`` is specified, ``dnssec-signzone`` generates
signatures that are valid for 30 days, with a cycle interval of 7.5 signatures that are valid for 30 days, with a cycle interval of 7.5
days. Therefore, if any existing RRSIG records are due to expire in days. Therefore, if any existing RRSIG records are due to expire in
less than 7.5 days, they would be replaced. less than 7.5 days, they are replaced.
**-I** input-format ``-I input-format``
The format of the input zone file. Possible formats are ``"text"`` This option sets the format of the input zone file. Possible formats are ``text``
(default), ``"raw"``, and ``"map"``. This option is primarily (the default), ``raw``, and ``map``. This option is primarily
intended to be used for dynamic signed zones so that the dumped zone intended to be used for dynamic signed zones, so that the dumped zone
file in a non-text format containing updates can be signed directly. file in a non-text format containing updates can be signed directly.
The use of this option does not make much sense for non-dynamic This option is not useful for non-dynamic zones.
zones.
**-j** jitter ``-j jitter``
When signing a zone with a fixed signature lifetime, all RRSIG When signing a zone with a fixed signature lifetime, all RRSIG
records issued at the time of signing expires simultaneously. If the records issued at the time of signing expire simultaneously. If the
zone is incrementally signed, i.e. a previously-signed zone is passed zone is incrementally signed, i.e., a previously signed zone is passed
as input to the signer, all expired signatures have to be regenerated as input to the signer, all expired signatures must be regenerated
at about the same time. The ``jitter`` option specifies a jitter at approximately the same time. The ``jitter`` option specifies a jitter
window that will be used to randomize the signature expire time, thus window that is used to randomize the signature expire time, thus
spreading incremental signature regeneration over time. spreading incremental signature regeneration over time.
Signature lifetime jitter also to some extent benefits validators and Signature lifetime jitter also, to some extent, benefits validators and
servers by spreading out cache expiration, i.e. if large numbers of servers by spreading out cache expiration, i.e., if large numbers of
RRSIGs don't expire at the same time from all caches there will be RRSIGs do not expire at the same time from all caches, there is
less congestion than if all validators need to refetch at mostly the less congestion than if all validators need to refetch at around the
same time. same time.
**-L** serial ``-L serial``
When writing a signed zone to "raw" or "map" format, set the "source When writing a signed zone to "raw" or "map" format, this option sets the "source
serial" value in the header to the specified serial number. (This is serial" value in the header to the specified ``serial`` number. (This is
expected to be used primarily for testing purposes.) expected to be used primarily for testing purposes.)
**-n** ncpus ``-n ncpus``
Specifies the number of threads to use. By default, one thread is This option specifies the number of threads to use. By default, one thread is
started for each detected CPU. started for each detected CPU.
**-N** soa-serial-format ``-N soa-serial-format``
The SOA serial number format of the signed zone. Possible formats are This option sets the SOA serial number format of the signed zone. Possible formats are
``"keep"`` (default), ``"increment"``, ``"unixtime"``, and ``keep`` (the default), ``increment``, ``unixtime``, and
``"date"``. ``date``.
``"keep"`` **keep**
Do not modify the SOA serial number. This format indicates that the SOA serial number should not be modified.
``"increment"`` **increment**
Increment the SOA serial number using :rfc:`1982` arithmetic. This format increments the SOA serial number using :rfc:`1982` arithmetic.
``"unixtime"`` **unixtime**
Set the SOA serial number to the number of seconds since epoch. This format sets the SOA serial number to the number of seconds since the beginning of the Unix epoch.
``"date"`` **date**
Set the SOA serial number to today's date in YYYYMMDDNN format. This format sets the SOA serial number to today's date, in YYYYMMDDNN format.
**-o** origin ``-o origin``
The zone origin. If not specified, the name of the zone file is This option sets the zone origin. If not specified, the name of the zone file is
assumed to be the origin. assumed to be the origin.
**-O** output-format ``-O output-format``
The format of the output file containing the signed zone. Possible This option sets the format of the output file containing the signed zone. Possible
formats are ``"text"`` (default), which is the standard textual formats are ``text`` (the default), which is the standard textual
representation of the zone; ``"full"``, which is text output in a representation of the zone; ``full``, which is text output in a
format suitable for processing by external scripts; and ``"map"``, format suitable for processing by external scripts; and ``map``,
``"raw"``, and ``"raw=N"``, which store the zone in binary formats ``raw``, and ``raw=N``, which store the zone in binary formats
for rapid loading by ``named``. ``"raw=N"`` specifies the format for rapid loading by ``named``. ``raw=N`` specifies the format
version of the raw zone file: if N is 0, the raw file can be read by version of the raw zone file: if N is 0, the raw file can be read by
any version of ``named``; if N is 1, the file can be read by release any version of ``named``; if N is 1, the file can be read by release
9.9.0 or higher; the default is 1. 9.9.0 or higher. The default is 1.
**-P** ``-P``
Disable post sign verification tests. This option disables post-sign verification tests.
The post sign verification test ensures that for each algorithm in The post-sign verification tests ensure that for each algorithm in
use there is at least one non revoked self signed KSK key, that all use there is at least one non-revoked self-signed KSK key, that all
revoked KSK keys are self signed, and that all records in the zone revoked KSK keys are self-signed, and that all records in the zone
are signed by the algorithm. This option skips these tests. are signed by the algorithm. This option skips these tests.
**-Q** ``-Q``
Remove signatures from keys that are no longer active. This option removes signatures from keys that are no longer active.
Normally, when a previously-signed zone is passed as input to the Normally, when a previously signed zone is passed as input to the
signer, and a DNSKEY record has been removed and replaced with a new signer, and a DNSKEY record has been removed and replaced with a new
one, signatures from the old key that are still within their validity one, signatures from the old key that are still within their validity
period are retained. This allows the zone to continue to validate period are retained. This allows the zone to continue to validate
with cached copies of the old DNSKEY RRset. The ``-Q`` forces with cached copies of the old DNSKEY RRset. The ``-Q`` option forces
``dnssec-signzone`` to remove signatures from keys that are no longer ``dnssec-signzone`` to remove signatures from keys that are no longer
active. This enables ZSK rollover using the procedure described in active. This enables ZSK rollover using the procedure described in
:rfc:`4641#4.2.1.1` ("Pre-Publish Key Rollover"). :rfc:`4641#4.2.1.1` ("Pre-Publish Key Rollover").
``-q`` ``-q``
Quiet mode: Suppresses unnecessary output. Without this option, when This option enables quiet mode, which suppresses unnecessary output. Without this option, when
``dnssec-signzone`` is run it will print to standard output the number of ``dnssec-signzone`` is run it prints three pieces of information to standard output: the number of
keys in use, the algorithms used to verify the zone was signed correctly and keys in use; the algorithms used to verify the zone was signed correctly and
other status information, and finally the filename containing the signed other status information; and the filename containing the signed
zone. With it, that output is suppressed, leaving only the filename. zone. With the option that output is suppressed, leaving only the filename.
**-R** ``-R``
Remove signatures from keys that are no longer published. This option removes signatures from keys that are no longer published.
This option is similar to ``-Q``, except it forces This option is similar to ``-Q``, except it forces
``dnssec-signzone`` to signatures from keys that are no longer ``dnssec-signzone`` to remove signatures from keys that are no longer
published. This enables ZSK rollover using the procedure described in published. This enables ZSK rollover using the procedure described in
:rfc:`4641#4.2.1.2` ("Double Signature Zone Signing Key :rfc:`4641#4.2.1.2` ("Double Signature Zone Signing Key
Rollover"). Rollover").
**-S** ``-S``
Smart signing: Instructs ``dnssec-signzone`` to search the key This option enables smart signing, which instructs ``dnssec-signzone`` to search the key
repository for keys that match the zone being signed, and to include repository for keys that match the zone being signed, and to include
them in the zone if appropriate. them in the zone if appropriate.
@@ -274,94 +273,94 @@ Options
If the key's publication date is set and is in the past, the key If the key's publication date is set and is in the past, the key
is published in the zone. is published in the zone.
If the key's activation date is set and in the past, the key is If the key's activation date is set and is in the past, the key is
published (regardless of publication date) and used to sign the published (regardless of publication date) and used to sign the
zone. zone.
If the key's revocation date is set and in the past, and the key If the key's revocation date is set and is in the past, and the key
is published, then the key is revoked, and the revoked key is used is published, then the key is revoked, and the revoked key is used
to sign the zone. to sign the zone.
If either of the key's unpublication or deletion dates are set and If either the key's unpublication or deletion date is set and
in the past, the key is NOT published or used to sign the zone, in the past, the key is NOT published or used to sign the zone,
regardless of any other metadata. regardless of any other metadata.
If key's sync publication date is set and in the past, If the key's sync publication date is set and is in the past,
synchronization records (type CDS and/or CDNSKEY) are created. synchronization records (type CDS and/or CDNSKEY) are created.
If key's sync deletion date is set and in the past, If the key's sync deletion date is set and is in the past,
synchronization records (type CDS and/or CDNSKEY) are removed. synchronization records (type CDS and/or CDNSKEY) are removed.
**-T** ttl ``-T ttl``
Specifies a TTL to be used for new DNSKEY records imported into the This option specifies a TTL to be used for new DNSKEY records imported into the
zone from the key repository. If not specified, the default is the zone from the key repository. If not specified, the default is the
TTL value from the zone's SOA record. This option is ignored when TTL value from the zone's SOA record. This option is ignored when
signing without ``-S``, since DNSKEY records are not imported from signing without ``-S``, since DNSKEY records are not imported from
the key repository in that case. It is also ignored if there are any the key repository in that case. It is also ignored if there are any
pre-existing DNSKEY records at the zone apex, in which case new pre-existing DNSKEY records at the zone apex, in which case new
records' TTL values will be set to match them, or if any of the records' TTL values are set to match them, or if any of the
imported DNSKEY records had a default TTL value. In the event of a a imported DNSKEY records had a default TTL value. In the event of a
conflict between TTL values in imported keys, the shortest one is conflict between TTL values in imported keys, the shortest one is
used. used.
**-t** ``-t``
Print statistics at completion. This option prints statistics at completion.
**-u** ``-u``
Update NSEC/NSEC3 chain when re-signing a previously signed zone. This option updates the NSEC/NSEC3 chain when re-signing a previously signed zone.
With this option, a zone signed with NSEC can be switched to NSEC3, With this option, a zone signed with NSEC can be switched to NSEC3,
or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with or a zone signed with NSEC3 can be switched to NSEC or to NSEC3 with
different parameters. Without this option, ``dnssec-signzone`` will different parameters. Without this option, ``dnssec-signzone``
retain the existing chain when re-signing. retains the existing chain when re-signing.
**-v** level ``-v level``
Sets the debugging level. This option sets the debugging level.
**-x** ``-x``
Only sign the DNSKEY, CDNSKEY, and CDS RRsets with key-signing keys, This option indicates that BIND 9 should only sign the DNSKEY, CDNSKEY, and CDS RRsets with key-signing keys,
and omit signatures from zone-signing keys. (This is similar to the and should omit signatures from zone-signing keys. (This is similar to the
``dnssec-dnskey-kskonly yes;`` zone option in ``named``.) ``dnssec-dnskey-kskonly yes;`` zone option in ``named``.)
**-z** ``-z``
Ignore KSK flag on key when determining what to sign. This causes This option indicates that BIND 9 should ignore the KSK flag on keys when determining what to sign. This causes
KSK-flagged keys to sign all records, not just the DNSKEY RRset. KSK-flagged keys to sign all records, not just the DNSKEY RRset.
(This is similar to the ``update-check-ksk no;`` zone option in (This is similar to the ``update-check-ksk no;`` zone option in
``named``.) ``named``.)
**-3** salt ``-3 salt``
Generate an NSEC3 chain with the given hex encoded salt. A dash This option generates an NSEC3 chain with the given hex-encoded salt. A dash
(salt) can be used to indicate that no salt is to be used when (-) can be used to indicate that no salt is to be used when
generating the NSEC3 chain. generating the NSEC3 chain.
**-H** iterations ``-H iterations``
When generating an NSEC3 chain, use this many iterations. The default This option indicates that, when generating an NSEC3 chain, BIND 9 should use this many iterations. The default
is 10. is 10.
**-A** ``-A``
When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 This option indicates that, when generating an NSEC3 chain, BIND 9 should set the OPTOUT flag on all NSEC3
records and do not generate NSEC3 records for insecure delegations. records and should not generate NSEC3 records for insecure delegations.
Using this option twice (i.e., ``-AA``) turns the OPTOUT flag off for Using this option twice (i.e., ``-AA``) turns the OPTOUT flag off for
all records. This is useful when using the ``-u`` option to modify an all records. This is useful when using the ``-u`` option to modify an
NSEC3 chain which previously had OPTOUT set. NSEC3 chain which previously had OPTOUT set.
**zonefile** ``zonefile``
The file containing the zone to be signed. This option sets the file containing the zone to be signed.
**key** ``key``
Specify which keys should be used to sign the zone. If no keys are This option specifies which keys should be used to sign the zone. If no keys are
specified, then the zone will be examined for DNSKEY records at the specified, the zone is examined for DNSKEY records at the
zone apex. If these are found and there are matching private keys, in zone apex. If these records are found and there are matching private keys in
the current directory, then these will be used for signing. the current directory, they are used for signing.
Example Example
~~~~~~~ ~~~~~~~
The following command signs the ``example.com`` zone with the The following command signs the ``example.com`` zone with the
ECDSAP256SHA256 key generated by key generated by ``dnssec-keygen`` ECDSAP256SHA256 key generated by ``dnssec-keygen``
(Kexample.com.+013+17247). Because the ``-S`` option is not being used, (Kexample.com.+013+17247). Because the ``-S`` option is not being used,
the zone's keys must be in the master file (``db.example.com``). This the zone's keys must be in the master file (``db.example.com``). This
invocation looks for ``dsset`` files, in the current directory, so that invocation looks for ``dsset`` files in the current directory, so that
DS records can be imported from them (``-g``). DS records can be imported from them (``-g``).
:: ::
@@ -373,7 +372,7 @@ DS records can be imported from them (``-g``).
In the above example, ``dnssec-signzone`` creates the file In the above example, ``dnssec-signzone`` creates the file
``db.example.com.signed``. This file should be referenced in a zone ``db.example.com.signed``. This file should be referenced in a zone
statement in a ``named.conf`` file. statement in the ``named.conf`` file.
This example re-signs a previously signed zone with default parameters. This example re-signs a previously signed zone with default parameters.
The private keys are assumed to be in the current directory. The private keys are assumed to be in the current directory.

78
bin/dnssec/dnssec-verify.rst
View File

@@ -35,72 +35,72 @@ Description
~~~~~~~~~~~ ~~~~~~~~~~~
``dnssec-verify`` verifies that a zone is fully signed for each ``dnssec-verify`` verifies that a zone is fully signed for each
algorithm found in the DNSKEY RRset for the zone, and that the NSEC / algorithm found in the DNSKEY RRset for the zone, and that the
NSEC3 chains are complete. NSEC/NSEC3 chains are complete.
Options Options
~~~~~~~ ~~~~~~~
**-c** class ``-c class``
Specifies the DNS class of the zone. This option specifies the DNS class of the zone.
**-E** engine ``-E engine``
Specifies the cryptographic hardware to use, when applicable. This option specifies the cryptographic hardware to use, when applicable.
When BIND is built with OpenSSL PKCS#11 support, this defaults to the When BIND is built with OpenSSL PKCS#11 support, this defaults to the
string "pkcs11", which identifies an OpenSSL engine that can drive a string ``pkcs11``, which identifies an OpenSSL engine that can drive a
cryptographic accelerator or hardware service module. When BIND is cryptographic accelerator or hardware service module. When BIND is
built with native PKCS#11 cryptography (--enable-native-pkcs11), it built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it
defaults to the path of the PKCS#11 provider library specified via defaults to the path of the PKCS#11 provider library specified via
"--with-pkcs11". ``--with-pkcs11``.
**-I** input-format ``-I input-format``
The format of the input zone file. Possible formats are ``"text"`` This option sets the format of the input zone file. Possible formats are ``text``
(default) and ``"raw"``. This option is primarily intended to be used (the default) and ``raw``. This option is primarily intended to be used
for dynamic signed zones so that the dumped zone file in a non-text for dynamic signed zones, so that the dumped zone file in a non-text
format containing updates can be verified independently. The use of format containing updates can be verified independently.
this option does not make much sense for non-dynamic zones. This option is not useful for non-dynamic zones.
**-o** origin ``-o origin``
The zone origin. If not specified, the name of the zone file is This option indicates the zone origin. If not specified, the name of the zone file is
assumed to be the origin. assumed to be the origin.
**-v** level ``-v level``
Sets the debugging level. This option sets the debugging level.
**-V** ``-V``
Prints version information. This option prints version information.
``-q`` ``-q``
Quiet mode: Suppresses output. Without this option, when ``dnssec-verify`` This option sets quiet mode, which suppresses output. Without this option, when ``dnssec-verify``
is run it will print to standard output the number of keys in use, the is run it prints to standard output the number of keys in use, the
algorithms used to verify the zone was signed correctly and other status algorithms used to verify the zone was signed correctly, and other status
information. With it, all non-error output is suppressed, and only the exit information. With this option, all non-error output is suppressed, and only the exit
code will indicate success. code indicates success.
**-x** ``-x``
Only verify that the DNSKEY RRset is signed with key-signing keys. This option verifies only that the DNSKEY RRset is signed with key-signing keys.
Without this flag, it is assumed that the DNSKEY RRset will be signed Without this flag, it is assumed that the DNSKEY RRset is signed
by all active keys. When this flag is set, it will not be an error if by all active keys. When this flag is set, it is not an error if
the DNSKEY RRset is not signed by zone-signing keys. This corresponds the DNSKEY RRset is not signed by zone-signing keys. This corresponds
to the ``-x`` option in ``dnssec-signzone``. to the ``-x`` option in ``dnssec-signzone``.
**-z** ``-z``
Ignore the KSK flag on the keys when determining whether the zone if This option indicates that the KSK flag on the keys should be ignored when determining whether the zone is
correctly signed. Without this flag it is assumed that there will be correctly signed. Without this flag, it is assumed that there is
a non-revoked, self-signed DNSKEY with the KSK flag set for each a non-revoked, self-signed DNSKEY with the KSK flag set for each
algorithm and that RRsets other than DNSKEY RRset will be signed with algorithm, and that RRsets other than DNSKEY RRset are signed with
a different DNSKEY without the KSK flag set. a different DNSKEY without the KSK flag set.
With this flag set, we only require that for each algorithm, there With this flag set, BIND 9 only requires that for each algorithm, there
will be at least one non-revoked, self-signed DNSKEY, regardless of be at least one non-revoked, self-signed DNSKEY, regardless of
the KSK flag state, and that other RRsets will be signed by a the KSK flag state, and that other RRsets be signed by a
non-revoked key for the same algorithm that includes the self-signed non-revoked key for the same algorithm that includes the self-signed
key; the same key may be used for both purposes. This corresponds to key; the same key may be used for both purposes. This corresponds to
the ``-z`` option in ``dnssec-signzone``. the ``-z`` option in ``dnssec-signzone``.
**zonefile** ``zonefile``
The file containing the zone to be signed. This option indicates the file containing the zone to be signed.
See Also See Also
~~~~~~~~ ~~~~~~~~

6
bin/named/named.conf.rst
View File

@@ -1,6 +1,6 @@
.. highlight: console .. highlight: console
named.conf - configuration file for **named** named.conf - configuration file for ``named``
--------------------------------------------- ---------------------------------------------
Synopsis Synopsis
@@ -12,13 +12,13 @@ Description
~~~~~~~~~~~ ~~~~~~~~~~~
``named.conf`` is the configuration file for ``named``. Statements are ``named.conf`` is the configuration file for ``named``. Statements are
enclosed in braces and terminated with a semi-colon. Clauses in the enclosed in braces (``[ ]``) and terminated with a semi-colon (``;``). Clauses in the
statements are also semi-colon terminated. The usual comment styles are statements are also semi-colon terminated. The usual comment styles are
supported: supported:
C style: /\* \*/ C style: /\* \*/
C++ style: // to end of line C++ style: // to end of line
Unix style: # to end of line Unix style: # to end of line

150
bin/named/named.rst
View File

@@ -38,119 +38,119 @@ Description
distribution from ISC. For more information on the DNS, see :rfc:`1033`, distribution from ISC. For more information on the DNS, see :rfc:`1033`,
:rfc:`1034`, and :rfc:`1035`. :rfc:`1034`, and :rfc:`1035`.
When invoked without arguments, ``named`` will read the default When invoked without arguments, ``named`` reads the default
configuration file ``/etc/named.conf``, read any initial data, and configuration file ``/etc/named.conf``, reads any initial data, and
listen for queries. listens for queries.
Options Options
~~~~~~~ ~~~~~~~
**-4** ``-4``
Use IPv4 only even if the host machine is capable of IPv6. ``-4`` and This option tells ``named`` to use only IPv4, even if the host machine is capable of IPv6. ``-4`` and
``-6`` are mutually exclusive. ``-6`` are mutually exclusive.
**-6** ``-6``
Use IPv6 only even if the host machine is capable of IPv4. ``-4`` and This option tells ``named`` to use only IPv6, even if the host machine is capable of IPv4. ``-4`` and
``-6`` are mutually exclusive. ``-6`` are mutually exclusive.
**-c** config-file ``-c config-file``
Use config-file as the configuration file instead of the default, This option tells ``named`` to use ``config-file`` as its configuration file instead of the default,
``/etc/named.conf``. To ensure that reloading the configuration file ``/etc/named.conf``. To ensure that the configuration file
continues to work after the server has changed its working directory can be reloaded after the server has changed its working directory
due to to a possible ``directory`` option in the configuration file, due to to a possible ``directory`` option in the configuration file,
config-file should be an absolute pathname. ``config-file`` should be an absolute pathname.
**-d** debug-level ``-d debug-level``
Set the daemon's debug level to debug-level. Debugging traces from This option sets the daemon's debug level to ``debug-level``. Debugging traces from
``named`` become more verbose as the debug level increases. ``named`` become more verbose as the debug level increases.
**-D** string ``-D string``
Specifies a string that is used to identify a instance of ``named`` This option specifies a string that is used to identify a instance of ``named``
in a process listing. The contents of string are not examined. in a process listing. The contents of ``string`` are not examined.
**-E** engine-name ``-E engine-name``
When applicable, specifies the hardware to use for cryptographic When applicable, this option specifies the hardware to use for cryptographic
operations, such as a secure key store used for signing. operations, such as a secure key store used for signing.
When BIND is built with OpenSSL PKCS#11 support, this defaults to the When BIND is built with OpenSSL PKCS#11 support, this defaults to the
string "pkcs11", which identifies an OpenSSL engine that can drive a string ``pkcs11``, which identifies an OpenSSL engine that can drive a
cryptographic accelerator or hardware service module. When BIND is cryptographic accelerator or hardware service module. When BIND is
built with native PKCS#11 cryptography (--enable-native-pkcs11), it built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it
defaults to the path of the PKCS#11 provider library specified via defaults to the path of the PKCS#11 provider library specified via
"--with-pkcs11". ``--with-pkcs11``.
**-f** ``-f``
Run the server in the foreground (i.e. do not daemonize). This option runs the server in the foreground (i.e., do not daemonize).
**-g** ``-g``
Run the server in the foreground and force all logging to ``stderr``. This option runs the server in the foreground and forces all logging to ``stderr``.
**-L** logfile ``-L logfile``
Log to the file ``logfile`` by default instead of the system log. This option sets the log to the file ``logfile`` by default, instead of the system log.
**-M** option ``-M option``
Sets the default memory context options. If set to external, this This option sets the default memory context options. If set to ``external``,
causes the internal memory manager to be bypassed in favor of the internal memory manager is bypassed in favor of
system-provided memory allocation functions. If set to fill, blocks system-provided memory allocation functions. If set to ``fill``, blocks
of memory will be filled with tag values when allocated or freed, to of memory are filled with tag values when allocated or freed, to
assist debugging of memory problems. (nofill disables this behavior, assist debugging of memory problems. ``nofill`` disables this behavior,
and is the default unless ``named`` has been compiled with developer and is the default unless ``named`` has been compiled with developer
options.) options.
**-m** flag ``-m flag``
Turn on memory usage debugging flags. Possible flags are usage, This option turns on memory usage debugging flags. Possible flags are ``usage``,
trace, record, size, and mctx. These correspond to the ``trace``, ``record``, ``size``, and ``mctx``. These correspond to the
ISC_MEM_DEBUGXXXX flags described in ``<isc/mem.h>``. ``ISC_MEM_DEBUGXXXX`` flags described in ``<isc/mem.h>``.
**-n** #cpus ``-n #cpus``
Create #cpus worker threads to take advantage of multiple CPUs. If This option creates ``#cpus`` worker threads to take advantage of multiple CPUs. If
not specified, ``named`` will try to determine the number of CPUs not specified, ``named`` tries to determine the number of CPUs
present and create one thread per CPU. If it is unable to determine present and creates one thread per CPU. If it is unable to determine
the number of CPUs, a single worker thread will be created. the number of CPUs, a single worker thread is created.
**-p** port ``-p port``
Listen for queries on port port. If not specified, the default is This option listens for queries on ``port``. If not specified, the default is
port 53. port 53.
**-s** ``-s``
Write memory usage statistics to ``stdout`` on exit. This option writes memory usage statistics to ``stdout`` on exit.
.. note:: .. note::
This option is mainly of interest to BIND 9 developers and may be This option is mainly of interest to BIND 9 developers and may be
removed or changed in a future release. removed or changed in a future release.
**-S** #max-socks ``-S #max-socks``
Allow ``named`` to use up to #max-socks sockets. The default value is This option allows ``named`` to use up to ``#max-socks`` sockets. The default value is
21000 on systems built with default configuration options, and 4096 21000 on systems built with default configuration options, and 4096
on systems built with "configure --with-tuning=small". on systems built with ``configure --with-tuning=small``.
.. warning:: .. warning::
This option should be unnecessary for the vast majority of users. This option should be unnecessary for the vast majority of users.
The use of this option could even be harmful because the specified The use of this option could even be harmful, because the specified
value may exceed the limitation of the underlying system API. It value may exceed the limitation of the underlying system API. It
is therefore set only when the default configuration causes is therefore set only when the default configuration causes
exhaustion of file descriptors and the operational environment is exhaustion of file descriptors and the operational environment is
known to support the specified number of sockets. Note also that known to support the specified number of sockets. Note also that
the actual maximum number is normally a little fewer than the the actual maximum number is normally slightly fewer than the
specified value because ``named`` reserves some file descriptors specified value, because ``named`` reserves some file descriptors
for its internal use. for its internal use.
**-t** directory ``-t directory``
Chroot to directory after processing the command line arguments, but This option tells ``named`` to chroot to ``directory`` after processing the command-line arguments, but
before reading the configuration file. before reading the configuration file.
.. warning:: .. warning::
This option should be used in conjunction with the ``-u`` option, This option should be used in conjunction with the ``-u`` option,
as chrooting a process running as root doesn't enhance security on as chrooting a process running as root doesn't enhance security on
most systems; the way ``chroot(2)`` is defined allows a process most systems; the way ``chroot`` is defined allows a process
with root privileges to escape a chroot jail. with root privileges to escape a chroot jail.
**-U** #listeners ``-U #listeners``
Use #listeners worker threads to listen for incoming UDP packets on This option tells ``named`` the number of ``#listeners`` worker threads to listen on, for incoming UDP packets on
each address. If not specified, ``named`` will calculate a default each address. If not specified, ``named`` calculates a default
value based on the number of detected CPUs: 1 for 1 CPU, and the value based on the number of detected CPUs: 1 for 1 CPU, and the
number of detected CPUs minus one for machines with more than 1 CPU. number of detected CPUs minus one for machines with more than 1 CPU.
This cannot be increased to a value higher than the number of CPUs. This cannot be increased to a value higher than the number of CPUs.
@@ -159,38 +159,38 @@ Options
higher. On Windows, the number of UDP listeners is hardwired to 1 and higher. On Windows, the number of UDP listeners is hardwired to 1 and
this option has no effect. this option has no effect.
**-u** user ``-u user``
Setuid to user after completing privileged operations, such as This option sets the setuid to ``user`` after completing privileged operations, such as
creating sockets that listen on privileged ports. creating sockets that listen on privileged ports.
.. note:: .. note::
On Linux, ``named`` uses the kernel's capability mechanism to drop On Linux, ``named`` uses the kernel's capability mechanism to drop
all root privileges except the ability to ``bind(2)`` to a all root privileges except the ability to ``bind`` to a
privileged port and set process resource limits. Unfortunately, privileged port and set process resource limits. Unfortunately,
this means that the ``-u`` option only works when ``named`` is run this means that the ``-u`` option only works when ``named`` is run
on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or later, since on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or later, since
previous kernels did not allow privileges to be retained after previous kernels did not allow privileges to be retained after
``setuid(2)``. ``setuid``.
**-v** ``-v``
Report the version number and exit. This option reports the version number and exits.
**-V** ``-V``
Report the version number and build options, and exit. This option reports the version number and build options, and exits.
**-X** lock-file ``-X lock-file``
Acquire a lock on the specified file at runtime; this helps to This option acquires a lock on the specified file at runtime; this helps to
prevent duplicate ``named`` instances from running simultaneously. prevent duplicate ``named`` instances from running simultaneously.
Use of this option overrides the ``lock-file`` option in Use of this option overrides the ``lock-file`` option in
``named.conf``. If set to ``none``, the lock file check is disabled. ``named.conf``. If set to ``none``, the lock file check is disabled.
**-x** cache-file ``-x cache-file``
Load data from cache-file into the cache of the default view. This option loads data from ``cache-file`` into the cache of the default view.
.. warning:: .. warning::
This option must not be used. It is only of interest to BIND 9 This option must not be used in normal operations. It is only of interest to BIND 9
developers and may be removed or changed in a future release. developers and may be removed or changed in a future release.
Signals Signals
@@ -200,10 +200,10 @@ In routine operation, signals should not be used to control the
nameserver; ``rndc`` should be used instead. nameserver; ``rndc`` should be used instead.
SIGHUP SIGHUP
Force a reload of the server. This signal forces a reload of the server.
SIGINT, SIGTERM SIGINT, SIGTERM
Shut down the server. These signals shut down the server.
The result of sending any other signals to the server is undefined. The result of sending any other signals to the server is undefined.

258
bin/nsupdate/nsupdate.rst
View File

@@ -34,8 +34,8 @@ Synopsis
Description Description
~~~~~~~~~~~ ~~~~~~~~~~~
``nsupdate`` is used to submit Dynamic DNS Update requests as defined in ``nsupdate`` is used to submit Dynamic DNS Update requests, as defined in
:rfc:`2136` to a name server. This allows resource records to be added or :rfc:`2136`, to a name server. This allows resource records to be added or
removed from a zone without manually editing the zone file. A single removed from a zone without manually editing the zone file. A single
update request can contain requests to add or remove more than one update request can contain requests to add or remove more than one
resource record. resource record.
@@ -45,23 +45,23 @@ should not be edited by hand. Manual edits could conflict with dynamic
updates and cause data to be lost. updates and cause data to be lost.
The resource records that are dynamically added or removed with The resource records that are dynamically added or removed with
``nsupdate`` have to be in the same zone. Requests are sent to the ``nsupdate`` must be in the same zone. Requests are sent to the
zone's primary server. This is identified by the MNAME field of the zone's primary server, which is identified by the MNAME field of the
zone's SOA record. zone's SOA record.
Transaction signatures can be used to authenticate the Dynamic DNS Transaction signatures can be used to authenticate the Dynamic DNS
updates. These use the TSIG resource record type described in :rfc:`2845` updates. These use the TSIG resource record type described in :rfc:`2845`,
or the SIG(0) record described in :rfc:`2535` and :rfc:`2931` or GSS-TSIG as the SIG(0) record described in :rfc:`2535` and :rfc:`2931`, or GSS-TSIG as
described in :rfc:`3645`. described in :rfc:`3645`.
TSIG relies on a shared secret that should only be known to ``nsupdate`` TSIG relies on a shared secret that should only be known to ``nsupdate``
and the name server. For instance, suitable ``key`` and ``server`` and the name server. For instance, suitable ``key`` and ``server``
statements would be added to ``/etc/named.conf`` so that the name server statements are added to ``/etc/named.conf`` so that the name server
can associate the appropriate secret key and algorithm with the IP can associate the appropriate secret key and algorithm with the IP
address of the client application that will be using TSIG address of the client application that is using TSIG
authentication. You can use ``ddns-confgen`` to generate suitable authentication. ``ddns-confgen`` can generate suitable
configuration fragments. ``nsupdate`` uses the ``-y`` or ``-k`` options configuration fragments. ``nsupdate`` uses the ``-y`` or ``-k`` options
to provide the TSIG shared secret. These options are mutually exclusive. to provide the TSIG shared secret; these options are mutually exclusive.
SIG(0) uses public key cryptography. To use a SIG(0) key, the public key SIG(0) uses public key cryptography. To use a SIG(0) key, the public key
must be stored in a KEY record in a zone served by the name server. must be stored in a KEY record in a zone served by the name server.
@@ -73,96 +73,96 @@ used by Windows 2000 can be switched on with the ``-o`` flag.
Options Options
~~~~~~~ ~~~~~~~
**-4** ``-4``
Use IPv4 only. This option sets use of IPv4 only.
**-6** ``-6``
Use IPv6 only. This option sets use of IPv6 only.
**-d** ``-d``
Debug mode. This provides tracing information about the update This option sets debug mode, which provides tracing information about the update
requests that are made and the replies received from the name server. requests that are made and the replies received from the name server.
**-D** ``-D``
Extra debug mode. This option sets extra debug mode.
**-i** ``-i``
Force interactive mode, even when standard input is not a terminal. This option forces interactive mode, even when standard input is not a terminal.
**-k** keyfile ``-k keyfile``
The file containing the TSIG authentication key. Keyfiles may be in This option indicates the file containing the TSIG authentication key. Keyfiles may be in
two formats: a single file containing a ``named.conf``-format ``key`` two formats: a single file containing a ``named.conf``-format ``key``
statement, which may be generated automatically by ``ddns-confgen``, statement, which may be generated automatically by ``ddns-confgen``;
or a pair of files whose names are of the format or a pair of files whose names are of the format
``K{name}.+157.+{random}.key`` and ``K{name}.+157.+{random}.key`` and
``K{name}.+157.+{random}.private``, which can be generated by ``K{name}.+157.+{random}.private``, which can be generated by
``dnssec-keygen``. The ``-k`` may also be used to specify a SIG(0) ``dnssec-keygen``. The ``-k`` option can also be used to specify a SIG(0)
key used to authenticate Dynamic DNS update requests. In this case, key used to authenticate Dynamic DNS update requests. In this case,
the key specified is not an HMAC-MD5 key. the key specified is not an HMAC-MD5 key.
**-l** ``-l``
Local-host only mode. This sets the server address to localhost This option sets local-host only mode, which sets the server address to localhost
(disabling the ``server`` so that the server address cannot be (disabling the ``server`` so that the server address cannot be
overridden). Connections to the local server will use a TSIG key overridden). Connections to the local server use a TSIG key
found in ``/var/run/named/session.key``, which is automatically found in ``/var/run/named/session.key``, which is automatically
generated by ``named`` if any local ``primary`` zone has set generated by ``named`` if any local ``primary`` zone has set
``update-policy`` to ``local``. The location of this key file can be ``update-policy`` to ``local``. The location of this key file can be
overridden with the ``-k`` option. overridden with the ``-k`` option.
**-L** level ``-L level``
Set the logging debug level. If zero, logging is disabled. This option sets the logging debug level. If zero, logging is disabled.
**-p** port ``-p port``
Set the port to use for connections to a name server. The default is This option sets the port to use for connections to a name server. The default is
53. 53.
**-P** ``-P``
Print the list of private BIND-specific resource record types whose This option prints the list of private BIND-specific resource record types whose
format is understood by ``nsupdate``. See also the ``-T`` option. format is understood by ``nsupdate``. See also the ``-T`` option.
**-r** udpretries ``-r udpretries``
The number of UDP retries. The default is 3. If zero, only one update This option sets the number of UDP retries. The default is 3. If zero, only one update
request will be made. request is made.
**-t** timeout ``-t timeout``
The maximum time an update request can take before it is aborted. The This option sets the maximum time an update request can take before it is aborted. The
default is 300 seconds. Zero can be used to disable the timeout. default is 300 seconds. If zero, the timeout is disabled.
**-T** ``-T``
Print the list of IANA standard resource record types whose format is This option prints the list of IANA standard resource record types whose format is
understood by ``nsupdate``. ``nsupdate`` will exit after the lists understood by ``nsupdate``. ``nsupdate`` exits after the lists
are printed. The ``-T`` option can be combined with the ``-P`` are printed. The ``-T`` option can be combined with the ``-P``
option. option.
Other types can be entered using "TYPEXXXXX" where "XXXXX" is the Other types can be entered using ``TYPEXXXXX`` where ``XXXXX`` is the
decimal value of the type with no leading zeros. The rdata, if decimal value of the type with no leading zeros. The rdata, if
present, will be parsed using the UNKNOWN rdata format, (<backslash> present, is parsed using the UNKNOWN rdata format, (<backslash>
<hash> <space> <length> <space> <hexstring>). <hash> <space> <length> <space> <hexstring>).
**-u** udptimeout ``-u udptimeout``
The UDP retry interval. The default is 3 seconds. If zero, the This option sets the UDP retry interval. The default is 3 seconds. If zero, the
interval will be computed from the timeout interval and number of UDP interval is computed from the timeout interval and number of UDP
retries. retries.
**-v** ``-v``
Use TCP even for small update requests. By default, ``nsupdate`` uses This option specifies that TCP should be used even for small update requests. By default, ``nsupdate`` uses
UDP to send update requests to the name server unless they are too UDP to send update requests to the name server unless they are too
large to fit in a UDP request in which case TCP will be used. TCP may large to fit in a UDP request, in which case TCP is used. TCP may
be preferable when a batch of update requests is made. be preferable when a batch of update requests is made.
**-V** ``-V``
Print the version number and exit. This option prints the version number and exits.
**-y** [hmac:]keyname:secret ``-y [hmac:]keyname:secret``
Literal TSIG authentication key. ``keyname`` is the name of the key, This option sets the literal TSIG authentication key. ``keyname`` is the name of the key,
and ``secret`` is the base64 encoded shared secret. ``hmac`` is the and ``secret`` is the base64 encoded shared secret. ``hmac`` is the
name of the key algorithm; valid choices are ``hmac-md5``, name of the key algorithm; valid choices are ``hmac-md5``,
``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, or ``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, or
``hmac-sha512``. If ``hmac`` is not specified, the default is ``hmac-sha512``. If ``hmac`` is not specified, the default is
``hmac-md5`` or if MD5 was disabled ``hmac-sha256``. ``hmac-md5``, or if MD5 was disabled, ``hmac-sha256``.
NOTE: Use of the ``-y`` option is discouraged because the shared NOTE: Use of the ``-y`` option is discouraged because the shared
secret is supplied as a command line argument in clear text. This may secret is supplied as a command-line argument in clear text. This may
be visible in the output from ps1 or in a history file maintained by be visible in the output from ps1 or in a history file maintained by
the user's shell. the user's shell.
@@ -171,142 +171,142 @@ Input Format
``nsupdate`` reads input from ``filename`` or standard input. Each ``nsupdate`` reads input from ``filename`` or standard input. Each
command is supplied on exactly one line of input. Some commands are for command is supplied on exactly one line of input. Some commands are for
administrative purposes. The others are either update instructions or administrative purposes; others are either update instructions or
prerequisite checks on the contents of the zone. These checks set prerequisite checks on the contents of the zone. These checks set
conditions that some name or set of resource records (RRset) either conditions that some name or set of resource records (RRset) either
exists or is absent from the zone. These conditions must be met if the exists or is absent from the zone. These conditions must be met if the
entire update request is to succeed. Updates will be rejected if the entire update request is to succeed. Updates are rejected if the
tests for the prerequisite conditions fail. tests for the prerequisite conditions fail.
Every update request consists of zero or more prerequisites and zero or Every update request consists of zero or more prerequisites and zero or
more updates. This allows a suitably authenticated update request to more updates. This allows a suitably authenticated update request to
proceed if some specified resource records are present or missing from proceed if some specified resource records are either present or missing from
the zone. A blank input line (or the ``send`` command) causes the the zone. A blank input line (or the ``send`` command) causes the
accumulated commands to be sent as one Dynamic DNS update request to the accumulated commands to be sent as one Dynamic DNS update request to the
name server. name server.
The command formats and their meaning are as follows: The command formats and their meanings are as follows:
``server`` servername port ``server servername port``
Sends all dynamic update requests to the name server ``servername``. This command sends all dynamic update requests to the name server ``servername``.
When no server statement is provided, ``nsupdate`` will send updates When no server statement is provided, ``nsupdate`` sends updates
to the primary server of the correct zone. The MNAME field of that to the primary server of the correct zone. The MNAME field of that
zone's SOA record will identify the primary server for that zone. zone's SOA record identify the primary server for that zone.
``port`` is the port number on ``servername`` where the dynamic ``port`` is the port number on ``servername`` where the dynamic
update requests get sent. If no port number is specified, the default update requests are sent. If no port number is specified, the default
DNS port number of 53 is used. DNS port number of 53 is used.
``local`` address port ``local address port``
Sends all dynamic update requests using the local ``address``. When This command sends all dynamic update requests using the local ``address``. When
no local statement is provided, ``nsupdate`` will send updates using no local statement is provided, ``nsupdate`` sends updates using
an address and port chosen by the system. ``port`` can additionally an address and port chosen by the system. ``port`` can also
be used to make requests come from a specific port. If no port number be used to force requests to come from a specific port. If no port number
is specified, the system will assign one. is specified, the system assigns one.
``zone`` zonename ``zone zonename``
Specifies that all updates are to be made to the zone ``zonename``. This command specifies that all updates are to be made to the zone ``zonename``.
If no ``zone`` statement is provided, ``nsupdate`` will attempt If no ``zone`` statement is provided, ``nsupdate`` attempts to
determine the correct zone to update based on the rest of the input. determine the correct zone to update based on the rest of the input.
``class`` classname ``class classname``
Specify the default class. If no ``class`` is specified, the default This command specifies the default class. If no ``class`` is specified, the default
class is ``IN``. class is ``IN``.
``ttl`` seconds ``ttl seconds``
Specify the default time to live for records to be added. The value This command specifies the default time-to-live, in seconds, for records to be added. The value
``none`` will clear the default ttl. ``none`` clears the default TTL.
``key`` hmac:keyname secret ``key hmac:keyname secret``
Specifies that all updates are to be TSIG-signed using the This command specifies that all updates are to be TSIG-signed using the
``keyname`` ``secret`` pair. If ``hmac`` is specified, then it sets ``keyname``-``secret`` pair. If ``hmac`` is specified, it sets
the signing algorithm in use; the default is ``hmac-md5`` or if MD5 the signing algorithm in use. The default is ``hmac-md5``; if MD5
was disabled ``hmac-sha256``. The ``key`` command overrides any key was disabled, the default is ``hmac-sha256``. The ``key`` command overrides any key
specified on the command line via ``-y`` or ``-k``. specified on the command line via ``-y`` or ``-k``.
``gsstsig`` ``gsstsig``
Use GSS-TSIG to sign the updated. This is equivalent to specifying This command uses GSS-TSIG to sign the updates. This is equivalent to specifying
``-g`` on the command line. ``-g`` on the command line.
``oldgsstsig`` ``oldgsstsig``
Use the Windows 2000 version of GSS-TSIG to sign the updated. This is This command uses the Windows 2000 version of GSS-TSIG to sign the updates. This is
equivalent to specifying ``-o`` on the command line. equivalent to specifying ``-o`` on the command line.
``realm`` [realm_name] ``realm [realm_name]``
When using GSS-TSIG use ``realm_name`` rather than the default realm When using GSS-TSIG, this command specifies the use of ``realm_name`` rather than the default realm
in ``krb5.conf``. If no realm is specified the saved realm is in ``krb5.conf``. If no realm is specified, the saved realm is
cleared. cleared.
``check-names`` [yes_or_no] ``check-names [yes_or_no]``
Turn on or off check-names processing on records to be added. This command turns on or off check-names processing on records to be added.
Check-names has no effect on prerequisites or records to be deleted. Check-names has no effect on prerequisites or records to be deleted.
By default check-names processing is on. If check-names processing By default check-names processing is on. If check-names processing
fails the record will not be added to the UPDATE message. fails, the record is not added to the UPDATE message.
``prereq nxdomain`` domain-name ``prereq nxdomain domain-name``
Requires that no resource record of any type exists with name This command requires that no resource record of any type exist with the name
``domain-name``. ``domain-name``.
``prereq yxdomain`` domain-name ``prereq yxdomain domain-name``
Requires that ``domain-name`` exists (has as at least one resource This command requires that ``domain-name`` exist (as at least one resource
record, of any type). record, of any type).
``prereq nxrrset`` domain-name class type ``prereq nxrrset domain-name class type``
Requires that no resource record exists of the specified ``type``, This command requires that no resource record exist of the specified ``type``,
``class`` and ``domain-name``. If ``class`` is omitted, IN (internet) ``class``, and ``domain-name``. If ``class`` is omitted, IN (Internet)
is assumed. is assumed.
``prereq yxrrset`` domain-name class type ``prereq yxrrset domain-name class type``
This requires that a resource record of the specified ``type``, This command requires that a resource record of the specified ``type``,
``class`` and ``domain-name`` must exist. If ``class`` is omitted, IN ``class`` and ``domain-name`` exist. If ``class`` is omitted, IN
(internet) is assumed. (internet) is assumed.
``prereq yxrrset`` domain-name class type data ``prereq yxrrset domain-name class type data``
The ``data`` from each set of prerequisites of this form sharing a With this command, the ``data`` from each set of prerequisites of this form sharing a
common ``type``, ``class``, and ``domain-name`` are combined to form common ``type``, ``class``, and ``domain-name`` are combined to form
a set of RRs. This set of RRs must exactly match the set of RRs a set of RRs. This set of RRs must exactly match the set of RRs
existing in the zone at the given ``type``, ``class``, and existing in the zone at the given ``type``, ``class``, and
``domain-name``. The ``data`` are written in the standard text ``domain-name``. The ``data`` are written in the standard text
representation of the resource record's RDATA. representation of the resource record's RDATA.
``update delete`` domain-name ttl class type data ``update delete domain-name ttl class type data``
Deletes any resource records named ``domain-name``. If ``type`` and This command deletes any resource records named ``domain-name``. If ``type`` and
``data`` is provided, only matching resource records will be removed. ``data`` are provided, only matching resource records are removed.
The internet class is assumed if ``class`` is not supplied. The The Internet class is assumed if ``class`` is not supplied. The
``ttl`` is ignored, and is only allowed for compatibility. ``ttl`` is ignored, and is only allowed for compatibility.
``update add`` domain-name ttl class type data ``update add domain-name ttl class type data``
Adds a new resource record with the specified ``ttl``, ``class`` and This command adds a new resource record with the specified ``ttl``, ``class``, and
``data``. ``data``.
``show`` ``show``
Displays the current message, containing all of the prerequisites and This command displays the current message, containing all of the prerequisites and
updates specified since the last send. updates specified since the last send.
``send`` ``send``
Sends the current message. This is equivalent to entering a blank This command sends the current message. This is equivalent to entering a blank
line. line.
``answer`` ``answer``
Displays the answer. This command displays the answer.
``debug`` ``debug``
Turn on debugging. This command turns on debugging.
``version`` ``version``
Print version number. This command prints the version number.
``help`` ``help``
Print a list of commands. This command prints a list of commands.
Lines beginning with a semicolon are comments and are ignored. Lines beginning with a semicolon (;) are comments and are ignored.
Examples Examples
~~~~~~~~ ~~~~~~~~
The examples below show how ``nsupdate`` could be used to insert and The examples below show how ``nsupdate`` can be used to insert and
delete resource records from the ``example.com`` zone. Notice that the delete resource records from the ``example.com`` zone. Notice that the
input in each example contains a trailing blank line so that a group of input in each example contains a trailing blank line, so that a group of
commands are sent as one dynamic update request to the primary name commands is sent as one dynamic update request to the primary name
server for ``example.com``. server for ``example.com``.
:: ::
@@ -316,9 +316,9 @@ server for ``example.com``.
> update add newhost.example.com 86400 A 172.16.1.1 > update add newhost.example.com 86400 A 172.16.1.1
> send > send
Any A records for ``oldhost.example.com`` are deleted. And an A record Any A records for ``oldhost.example.com`` are deleted, and an A record
for ``newhost.example.com`` with IP address 172.16.1.1 is added. The for ``newhost.example.com`` with IP address 172.16.1.1 is added. The
newly-added record has a 1 day TTL (86400 seconds). newly added record has a TTL of 1 day (86400 seconds).
:: ::
@@ -327,29 +327,29 @@ newly-added record has a 1 day TTL (86400 seconds).
> update add nickname.example.com 86400 CNAME somehost.example.com > update add nickname.example.com 86400 CNAME somehost.example.com
> send > send
The prerequisite condition gets the name server to check that there are The prerequisite condition tells the name server to verify that there are
no resource records of any type for ``nickname.example.com``. If there no resource records of any type for ``nickname.example.com``. If there
are, the update request fails. If this name does not exist, a CNAME for are, the update request fails. If this name does not exist, a CNAME for
it is added. This ensures that when the CNAME is added, it cannot it is added. This ensures that when the CNAME is added, it cannot
conflict with the long-standing rule in :rfc:`1034` that a name must not conflict with the long-standing rule in :rfc:`1034` that a name must not
exist as any other record type if it exists as a CNAME. (The rule has exist as any other record type if it exists as a CNAME. (The rule has
been updated for DNSSEC in :rfc:`2535` to allow CNAMEs to have RRSIG, been updated for DNSSEC in :rfc:`2535` to allow CNAMEs to have RRSIG,
DNSKEY and NSEC records.) DNSKEY, and NSEC records.)
Files Files
~~~~~ ~~~~~
``/etc/resolv.conf`` ``/etc/resolv.conf``
used to identify default name server Used to identify the default name server
``/var/run/named/session.key`` ``/var/run/named/session.key``
sets the default TSIG key for use in local-only mode Sets the default TSIG key for use in local-only mode
``K{name}.+157.+{random}.key`` ``K{name}.+157.+{random}.key``
base-64 encoding of HMAC-MD5 key created by dnssec-keygen8. Base-64 encoding of the HMAC-MD5 key created by ``dnssec-keygen``.
``K{name}.+157.+{random}.private`` ``K{name}.+157.+{random}.private``
base-64 encoding of HMAC-MD5 key created by dnssec-keygen8. Base-64 encoding of the HMAC-MD5 key created by ``dnssec-keygen``.
See Also See Also
~~~~~~~~ ~~~~~~~~
@@ -361,5 +361,5 @@ Bugs
~~~~ ~~~~
The TSIG key is redundantly stored in two separate files. This is a The TSIG key is redundantly stored in two separate files. This is a
consequence of nsupdate using the DST library for its cryptographic consequence of ``nsupdate`` using the DST library for its cryptographic
operations, and may change in future releases. operations, and may change in future releases.

34
bin/pkcs11/pkcs11-destroy.rst
View File

@@ -37,32 +37,32 @@ Description
by their ``ID`` or ``label``. by their ``ID`` or ``label``.
Matching keys are displayed before being destroyed. By default, there is Matching keys are displayed before being destroyed. By default, there is
a five second delay to allow the user to interrupt the process before a five-second delay to allow the user to interrupt the process before
the destruction takes place. the destruction takes place.
Arguments Options
~~~~~~~~~ ~~~~~~~
**-m** module ``-m module``
Specify the PKCS#11 provider module. This must be the full path to a This option specifies the PKCS#11 provider module. This must be the full path to a
shared library object implementing the PKCS#11 API for the device. shared library object implementing the PKCS#11 API for the device.
**-s** slot ``-s slot``
Open the session with the given PKCS#11 slot. The default is slot 0. This option opens the session with the given PKCS#11 slot. The default is slot 0.
**-i** ID ``-i ID``
Destroy keys with the given object ID. This option destroys keys with the given object ID.
**-l** label ``-l label``
Destroy keys with the given label. This option destroys keys with the given label.
**-p** PIN ``-p PIN``
Specify the PIN for the device. If no PIN is provided on the command This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command
line, ``pkcs11-destroy`` will prompt for it. line, ``pkcs11-destroy`` prompts for it.
**-w** seconds ``-w seconds``
Specify how long to pause before carrying out key destruction. The This option specifies how long, in seconds, to pause before carrying out key destruction. The
default is five seconds. If set to ``0``, destruction will be default is 5 seconds. If set to ``0``, destruction is
immediate. immediate.
See Also See Also

58
bin/pkcs11/pkcs11-keygen.rst
View File

@@ -38,51 +38,51 @@ Description
with the given ``label`` (which must be unique) and with ``keysize`` with the given ``label`` (which must be unique) and with ``keysize``
bits of prime. bits of prime.
Arguments Options
~~~~~~~~~ ~~~~~~~
**-a** algorithm ``-a algorithm``
Specify the key algorithm class: Supported classes are RSA, DSA, DH, This option specifies the key algorithm class: supported classes are RSA, DSA, DH,
ECC and ECX. In addition to these strings, the ``algorithm`` can be ECC, and ECX. In addition to these strings, the ``algorithm`` can be
specified as a DNSSEC signing algorithm that will be used with this specified as a DNSSEC signing algorithm to be used with this
key; for example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps to key; for example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps to
ECC, and ED25519 to ECX. The default class is "RSA". ECC, and ED25519 to ECX. The default class is ``RSA``.
**-b** keysize ``-b keysize``
Create the key pair with ``keysize`` bits of prime. For ECC keys, the This option creates the key pair with ``keysize`` bits of prime. For ECC keys, the
only valid values are 256 and 384, and the default is 256. For ECX only valid values are 256 and 384, and the default is 256. For ECX
keys, the only valid values are 256 and 456, and the default is 256. keys, the only valid values are 256 and 456, and the default is 256.
**-e** ``-e``
For RSA keys only, use a large exponent. For RSA keys only, this option specifies use of a large exponent.
**-i** id ``-i id``
Create key objects with id. The id is either an unsigned short 2 byte This option creates key objects with ``id``. The ID is either an unsigned short 2-byte
or an unsigned long 4 byte number. or an unsigned long 4-byte number.
**-m** module ``-m module``
Specify the PKCS#11 provider module. This must be the full path to a This option specifies the PKCS#11 provider module. This must be the full path to a
shared library object implementing the PKCS#11 API for the device. shared library object implementing the PKCS#11 API for the device.
**-P** ``-P``
Set the new private key to be non-sensitive and extractable. The This option sets the new private key to be non-sensitive and extractable, and
allows the private key data to be read from the PKCS#11 device. The allows the private key data to be read from the PKCS#11 device. The
default is for private keys to be sensitive and non-extractable. default is for private keys to be sensitive and non-extractable.
**-p** PIN ``-p PIN``
Specify the PIN for the device. If no PIN is provided on the command This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command
line, ``pkcs11-keygen`` will prompt for it. line, ``pkcs11-keygen`` prompts for it.
**-q** ``-q``
Quiet mode: suppress unnecessary output. This option sets quiet mode, which suppresses unnecessary output.
**-S** ``-S``
For Diffie-Hellman (DH) keys only, use a special prime of 768, 1024 For Diffie-Hellman (DH) keys only, this option specifies use of a special prime of 768-, 1024-,
or 1536 bit size and base (aka generator) 2. If not specified, bit or 1536-bit size and base (AKA generator) 2. If not specified, bit
size will default to 1024. size defaults to 1024.
**-s** slot ``-s slot``
Open the session with the given PKCS#11 slot. The default is slot 0. This option opens the session with the given PKCS#11 slot. The default is slot 0.
See Also See Also
~~~~~~~~ ~~~~~~~~

34
bin/pkcs11/pkcs11-list.rst
View File

@@ -31,34 +31,34 @@ pkcs11-list - list PKCS#11 objects
Description Description
~~~~~~~~~~~ ~~~~~~~~~~~
``pkcs11-list`` lists the PKCS#11 objects with ``ID`` or ``label`` or by ``pkcs11-list`` lists the PKCS#11 objects with ``ID`` or ``label`` or, by
default all objects. The object class, label, and ID are displayed for default, all objects. The object class, label, and ID are displayed for
all keys. For private or secret keys, the extractability attribute is all keys. For private or secret keys, the extractability attribute is
also displayed, as either ``true``, ``false``, or ``never``. also displayed, as either ``true``, ``false``, or ``never``.
Arguments Options
~~~~~~~~~ ~~~~~~~
**-P** ``-P``
List only the public objects. (Note that on some PKCS#11 devices, all This option lists only the public objects. (Note that on some PKCS#11 devices, all
objects are private.) objects are private.)
**-m** module ``-m module``
Specify the PKCS#11 provider module. This must be the full path to a This option specifies the PKCS#11 provider module. This must be the full path to a
shared library object implementing the PKCS#11 API for the device. shared library object implementing the PKCS#11 API for the device.
**-s** slot ``-s slot``
Open the session with the given PKCS#11 slot. The default is slot 0. This option opens the session with the given PKCS#11 slot. The default is slot 0.
**-i** ID ``-i ID``
List only key objects with the given object ID. This option lists only key objects with the given object ID.
**-l** label ``-l label``
List only key objects with the given label. This option lists only key objects with the given label.
**-p** PIN ``-p PIN``
Specify the PIN for the device. If no PIN is provided on the command This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command
line, ``pkcs11-list`` will prompt for it. line, ``pkcs11-list`` prompts for it.
See Also See Also
~~~~~~~~ ~~~~~~~~

12
bin/pkcs11/pkcs11-tokens.rst
View File

@@ -37,15 +37,15 @@ Description
``pkcs11-tokens`` lists the PKCS#11 available tokens with defaults from ``pkcs11-tokens`` lists the PKCS#11 available tokens with defaults from
the slot/token scan performed at application initialization. the slot/token scan performed at application initialization.
Arguments Options
~~~~~~~~~ ~~~~~~~
**-m** module ``-m module``
Specify the PKCS#11 provider module. This must be the full path to a This option specifies the PKCS#11 provider module. This must be the full path to a
shared library object implementing the PKCS#11 API for the device. shared library object implementing the PKCS#11 API for the device.
**-v** ``-v``
Make the PKCS#11 libisc initialization verbose. This option makes the PKCS#11 libisc initialization verbose.
See Also See Also
~~~~~~~~ ~~~~~~~~

22
bin/plugins/filter-aaaa.rst
View File

@@ -40,7 +40,7 @@ Description
Until BIND 9.12, this feature was implemented natively in ``named`` and Until BIND 9.12, this feature was implemented natively in ``named`` and
enabled with the ``filter-aaaa`` ACL and the ``filter-aaaa-on-v4`` and enabled with the ``filter-aaaa`` ACL and the ``filter-aaaa-on-v4`` and
``filter-aaaa-on-v6`` options. These options are now deprecated in ``filter-aaaa-on-v6`` options. These options are now deprecated in
``named.conf``, but can be passed as parameters to the ``named.conf`` but can be passed as parameters to the
``filter-aaaa.so`` plugin, for example: ``filter-aaaa.so`` plugin, for example:
:: ::
@@ -60,22 +60,22 @@ necessary.
Note: This mechanism can erroneously cause other servers not to give Note: This mechanism can erroneously cause other servers not to give
AAAA records to their clients. If a recursing server with both IPv6 and AAAA records to their clients. If a recursing server with both IPv6 and
IPv4 network connections queries an authoritative server using this IPv4 network connections queries an authoritative server using this
mechanism via IPv4, it will be denied AAAA records even if its client is mechanism via IPv4, it is denied AAAA records even if its client is
using IPv6. using IPv6.
Options Options
~~~~~~~ ~~~~~~~
``filter-aaaa`` ``filter-aaaa``
Specifies a list of client addresses for which AAAA filtering is to This option specifies a list of client addresses for which AAAA filtering is to
be applied. The default is ``any``. be applied. The default is ``any``.
``filter-aaaa-on-v4`` ``filter-aaaa-on-v4``
If set to ``yes``, the DNS client is at an IPv4 address, in If set to ``yes``, this option indicates that the DNS client is at an IPv4 address, in
``filter-aaaa``, and if the response does not include DNSSEC ``filter-aaaa``. If the response does not include DNSSEC
signatures, then all AAAA records are deleted from the response. This signatures, then all AAAA records are deleted from the response. This
filtering applies to all responses and not only authoritative filtering applies to all responses, not only authoritative
responses. ones.
If set to ``break-dnssec``, then AAAA records are deleted even when If set to ``break-dnssec``, then AAAA records are deleted even when
DNSSEC is enabled. As suggested by the name, this causes the response DNSSEC is enabled. As suggested by the name, this causes the response
@@ -83,13 +83,13 @@ Options
deletions. deletions.
This mechanism can erroneously cause other servers not to give AAAA This mechanism can erroneously cause other servers not to give AAAA
records to their clients. A recursing server with both IPv6 and IPv4 records to their clients. If a recursing server with both IPv6 and IPv4
network connections that queries an authoritative server using this network connections queries an authoritative server using this
mechanism via IPv4 will be denied AAAA records even if its client is mechanism via IPv4, it is denied AAAA records even if its client is
using IPv6. using IPv6.
``filter-aaaa-on-v6`` ``filter-aaaa-on-v6``
Identical to ``filter-aaaa-on-v4``, except it filters AAAA responses This option is identical to ``filter-aaaa-on-v4``, except that it filters AAAA responses
to queries from IPv6 clients instead of IPv4 clients. To filter all to queries from IPv6 clients instead of IPv4 clients. To filter all
responses, set both options to ``yes``. responses, set both options to ``yes``.

100
bin/rndc/rndc.rst
View File

@@ -57,22 +57,22 @@ Options
~~~~~~~ ~~~~~~~
``-4`` ``-4``
This indicates use of IPv4 only. This option indicates use of IPv4 only.
``-6`` ``-6``
This indicates use of IPv6 only. This option indicates use of IPv6 only.
``-b source-address`` ``-b source-address``
This indicates ``source-address`` as the source address for the connection to the This option indicates ``source-address`` as the source address for the connection to the
server. Multiple instances are permitted, to allow setting of both the server. Multiple instances are permitted, to allow setting of both the
IPv4 and IPv6 source addresses. IPv4 and IPv6 source addresses.
``-c config-file`` ``-c config-file``
This indicates ``config-file`` as the configuration file instead of the default, This option indicates ``config-file`` as the configuration file instead of the default,
``/etc/rndc.conf``. ``/etc/rndc.conf``.
``-k key-file`` ``-k key-file``
This indicates ``key-file`` as the key file instead of the default, This option indicates ``key-file`` as the key file instead of the default,
``/etc/rndc.key``. The key in ``/etc/rndc.key`` is used to ``/etc/rndc.key``. The key in ``/etc/rndc.key`` is used to
authenticate commands sent to the server if the config-file does not authenticate commands sent to the server if the config-file does not
exist. exist.
@@ -85,23 +85,23 @@ Options
is used. is used.
``-p port`` ``-p port``
This instructs BIND 9 to send commands to TCP port ``port`` instead of its default control This option instructs BIND 9 to send commands to TCP port ``port`` instead of its default control
channel port, 953. channel port, 953.
``-q`` ``-q``
This sets quiet mode, where message text returned by the server is not printed This option sets quiet mode, where message text returned by the server is not printed
unless there is an error. unless there is an error.
``-r`` ``-r``
This instructs ``rndc`` to print the result code returned by ``named`` This option instructs ``rndc`` to print the result code returned by ``named``
after executing the requested command (e.g., ISC_R_SUCCESS, after executing the requested command (e.g., ISC_R_SUCCESS,
ISC_R_FAILURE, etc.). ISC_R_FAILURE, etc.).
``-V`` ``-V``
This enables verbose logging. This option enables verbose logging.
``-y key_id`` ``-y key_id``
This indicates use of the key ``key_id`` from the configuration file. For control message validation to succeed, ``key_id`` must be known This option indicates use of the key ``key_id`` from the configuration file. For control message validation to succeed, ``key_id`` must be known
by ``named`` with the same algorithm and secret string. If no ``key_id`` is specified, by ``named`` with the same algorithm and secret string. If no ``key_id`` is specified,
``rndc`` first looks for a key clause in the server statement of ``rndc`` first looks for a key clause in the server statement of
the server being used, or if no server statement is present for that the server being used, or if no server statement is present for that
@@ -119,7 +119,7 @@ without arguments.
Currently supported commands are: Currently supported commands are:
``addzone`` *zone* [*class* [*view*]] *configuration* ``addzone`` *zone* [*class* [*view*]] *configuration*
This adds a zone while the server is running. This command requires the This command adds a zone while the server is running. This command requires the
``allow-new-zones`` option to be set to ``yes``. The configuration ``allow-new-zones`` option to be set to ``yes``. The configuration
string specified on the command line is the zone configuration text string specified on the command line is the zone configuration text
that would ordinarily be placed in ``named.conf``. that would ordinarily be placed in ``named.conf``.
@@ -144,7 +144,7 @@ Currently supported commands are:
See also ``rndc delzone`` and ``rndc modzone``. See also ``rndc delzone`` and ``rndc modzone``.
``delzone`` [**-clean**] *zone* [*class* [*view*]] ``delzone`` [**-clean**] *zone* [*class* [*view*]]
This deletes a zone while the server is running. This command deletes a zone while the server is running.
If the ``-clean`` argument is specified, the zone's master file (and If the ``-clean`` argument is specified, the zone's master file (and
journal file, if any) are deleted along with the zone. Without journal file, if any) are deleted along with the zone. Without
@@ -166,7 +166,7 @@ Currently supported commands are:
zone to have a "dnssec-policy". zone to have a "dnssec-policy".
``dnstap`` ( **-reopen** | **-roll** [*number*] ) ``dnstap`` ( **-reopen** | **-roll** [*number*] )
This closes and re-opens DNSTAP output files. ``rndc dnstap -reopen`` allows This command closes and re-opens DNSTAP output files. ``rndc dnstap -reopen`` allows
the output file to be renamed externally, so that ``named`` can the output file to be renamed externally, so that ``named`` can
truncate and re-open it. ``rndc dnstap -roll`` causes the output file truncate and re-open it. ``rndc dnstap -roll`` causes the output file
to be rolled automatically, similar to log files. The most recent to be rolled automatically, similar to log files. The most recent
@@ -175,25 +175,25 @@ Currently supported commands are:
the number of backup log files is limited to that number. the number of backup log files is limited to that number.
``dumpdb`` [**-all** | **-cache** | **-zones** | **-adb** | **-bad** | **-fail**] [*view ...*] ``dumpdb`` [**-all** | **-cache** | **-zones** | **-adb** | **-bad** | **-fail**] [*view ...*]
This dumps the server's caches (default) and/or zones to the dump file for This command dumps the server's caches (default) and/or zones to the dump file for
the specified views. If no view is specified, all views are dumped. the specified views. If no view is specified, all views are dumped.
(See the ``dump-file`` option in the BIND 9 Administrator Reference (See the ``dump-file`` option in the BIND 9 Administrator Reference
Manual.) Manual.)
``flush`` ``flush``
This flushes the server's cache. This command flushes the server's cache.
``flushname`` *name* [*view*] ``flushname`` *name* [*view*]
This flushes the given name from the view's DNS cache and, if applicable, This command flushes the given name from the view's DNS cache and, if applicable,
from the view's nameserver address database, bad server cache, and from the view's nameserver address database, bad server cache, and
SERVFAIL cache. SERVFAIL cache.
``flushtree`` *name* [*view*] ``flushtree`` *name* [*view*]
This flushes the given name, and all of its subdomains, from the view's This command flushes the given name, and all of its subdomains, from the view's
DNS cache, address database, bad server cache, and SERVFAIL cache. DNS cache, address database, bad server cache, and SERVFAIL cache.
``freeze`` [*zone* [*class* [*view*]]] ``freeze`` [*zone* [*class* [*view*]]]
This suspends updates to a dynamic zone. If no zone is specified, then all This command suspends updates to a dynamic zone. If no zone is specified, then all
zones are suspended. This allows manual edits to be made to a zone zones are suspended. This allows manual edits to be made to a zone
normally updated by dynamic update, and causes changes in the normally updated by dynamic update, and causes changes in the
journal file to be synced into the master file. All dynamic update journal file to be synced into the master file. All dynamic update
@@ -202,7 +202,7 @@ Currently supported commands are:
See also ``rndc thaw``. See also ``rndc thaw``.
``halt`` [**-p**] ``halt`` [**-p**]
This stops the server immediately. Recent changes made through dynamic This command stops the server immediately. Recent changes made through dynamic
update or IXFR are not saved to the master files, but are rolled update or IXFR are not saved to the master files, but are rolled
forward from the journal files when the server is restarted. If forward from the journal files when the server is restarted. If
``-p`` is specified, ``named``'s process ID is returned. This allows ``-p`` is specified, ``named``'s process ID is returned. This allows
@@ -212,7 +212,7 @@ Currently supported commands are:
See also ``rndc stop``. See also ``rndc stop``.
``loadkeys`` [*zone* [*class* [*view*]]] ``loadkeys`` [*zone* [*class* [*view*]]]
This fetches all DNSSEC keys for the given zone from the key directory. If This command fetches all DNSSEC keys for the given zone from the key directory. If
they are within their publication period, they are merged into the they are within their publication period, they are merged into the
zone's DNSKEY RRset. Unlike ``rndc sign``, however, the zone is not zone's DNSKEY RRset. Unlike ``rndc sign``, however, the zone is not
immediately re-signed by the new keys, but is allowed to immediately re-signed by the new keys, but is allowed to
@@ -224,7 +224,7 @@ Currently supported commands are:
the Administrator Reference Manual for more details.) the Administrator Reference Manual for more details.)
``managed-keys`` (*status* | *refresh* | *sync* | *destroy*) [*class* [*view*]] ``managed-keys`` (*status* | *refresh* | *sync* | *destroy*) [*class* [*view*]]
This inspects and controls the "managed-keys" database which handles This command inspects and controls the "managed-keys" database which handles
:rfc:`5011` DNSSEC trust anchor maintenance. If a view is specified, these :rfc:`5011` DNSSEC trust anchor maintenance. If a view is specified, these
commands are applied to that view; otherwise, they are applied to all commands are applied to that view; otherwise, they are applied to all
views. views.
@@ -262,7 +262,7 @@ Currently supported commands are:
repair for key maintenance problems. repair for key maintenance problems.
``modzone`` *zone* [*class* [*view*]] *configuration* ``modzone`` *zone* [*class* [*view*]] *configuration*
This modifies the configuration of a zone while the server is running. This This command modifies the configuration of a zone while the server is running. This
command requires the ``allow-new-zones`` option to be set to ``yes``. command requires the ``allow-new-zones`` option to be set to ``yes``.
As with ``addzone``, the configuration string specified on the As with ``addzone``, the configuration string specified on the
command line is the zone configuration text that would ordinarily be command line is the zone configuration text that would ordinarily be
@@ -280,15 +280,15 @@ Currently supported commands are:
See also ``rndc addzone`` and ``rndc delzone``. See also ``rndc addzone`` and ``rndc delzone``.
``notify`` *zone* [*class* [*view*]] ``notify`` *zone* [*class* [*view*]]
This resends NOTIFY messages for the zone. This command resends NOTIFY messages for the zone.
``notrace`` ``notrace``
This sets the server's debugging level to 0. This command sets the server's debugging level to 0.
See also ``rndc trace``. See also ``rndc trace``.
``nta`` [( **-class** *class* | **-dump** | **-force** | **-remove** | **-lifetime** *duration*)] *domain* [*view*] ``nta`` [( **-class** *class* | **-dump** | **-force** | **-remove** | **-lifetime** *duration*)] *domain* [*view*]
This sets a DNSSEC negative trust anchor (NTA) for ``domain``, with a This command sets a DNSSEC negative trust anchor (NTA) for ``domain``, with a
lifetime of ``duration``. The default lifetime is configured in lifetime of ``duration``. The default lifetime is configured in
``named.conf`` via the ``nta-lifetime`` option, and defaults to one ``named.conf`` via the ``nta-lifetime`` option, and defaults to one
hour. The lifetime cannot exceed one week. hour. The lifetime cannot exceed one week.
@@ -339,7 +339,7 @@ Currently supported commands are:
command line to indicate the end of options. command line to indicate the end of options.
``querylog`` [(*on* | *off*)] ``querylog`` [(*on* | *off*)]
This enables or disables query logging. For backward compatibility, this This command enables or disables query logging. For backward compatibility, this
command can also be used without an argument to toggle query logging command can also be used without an argument to toggle query logging
on and off. on and off.
@@ -349,29 +349,29 @@ Currently supported commands are:
``options`` section of ``named.conf``. ``options`` section of ``named.conf``.
``reconfig`` ``reconfig``
This reloads the configuration file and loads new zones, but does not reload This command reloads the configuration file and loads new zones, but does not reload
existing zone files even if they have changed. This is faster than a existing zone files even if they have changed. This is faster than a
full ``reload`` when there is a large number of zones, because it full ``reload`` when there is a large number of zones, because it
avoids the need to examine the modification times of the zone files. avoids the need to examine the modification times of the zone files.
``recursing`` ``recursing``
This dumps the list of queries ``named`` is currently recursing on, and the This command dumps the list of queries ``named`` is currently recursing on, and the
list of domains to which iterative queries are currently being sent. list of domains to which iterative queries are currently being sent.
The second list includes the number of fetches currently active for The second list includes the number of fetches currently active for
the given domain, and how many have been passed or dropped because of the given domain, and how many have been passed or dropped because of
the ``fetches-per-zone`` option. the ``fetches-per-zone`` option.
``refresh`` *zone* [*class* [*view*]] ``refresh`` *zone* [*class* [*view*]]
This schedules zone maintenance for the given zone. This command schedules zone maintenance for the given zone.
``reload`` ``reload``
This reloads the configuration file and zones. This command reloads the configuration file and zones.
``reload`` *zone* [*class* [*view*]] ``reload`` *zone* [*class* [*view*]]
This reloads the given zone. This command reloads the given zone.
``retransfer`` *zone* [*class* [*view*]] ``retransfer`` *zone* [*class* [*view*]]
This retransfers the given secondary zone from the primary server. This command retransfers the given secondary zone from the primary server.
If the zone is configured to use ``inline-signing``, the signed If the zone is configured to use ``inline-signing``, the signed
version of the zone is discarded; after the retransfer of the version of the zone is discarded; after the retransfer of the
@@ -379,12 +379,12 @@ Currently supported commands are:
with new signatures. with new signatures.
``scan`` ``scan``
This scans the list of available network interfaces for changes, without This command scans the list of available network interfaces for changes, without
performing a full ``reconfig`` or waiting for the performing a full ``reconfig`` or waiting for the
``interface-interval`` timer. ``interface-interval`` timer.
``secroots`` [**-**] [*view* ...] ``secroots`` [**-**] [*view* ...]
This dumps the security roots (i.e., trust anchors configured via This command dumps the security roots (i.e., trust anchors configured via
``trust-anchors``, or the ``managed-keys`` or ``trusted-keys`` statements ``trust-anchors``, or the ``managed-keys`` or ``trusted-keys`` statements
[both deprecated], or ``dnssec-validation auto``) and negative trust anchors [both deprecated], or ``dnssec-validation auto``) and negative trust anchors
for the specified views. If no view is specified, all views are for the specified views. If no view is specified, all views are
@@ -401,7 +401,7 @@ Currently supported commands are:
See also ``rndc managed-keys``. See also ``rndc managed-keys``.
``serve-stale`` (**on** | **off** | **reset** | **status**) [*class* [*view*]] ``serve-stale`` (**on** | **off** | **reset** | **status**) [*class* [*view*]]
This enables, disables, resets, or reports the current status of the serving This command enables, disables, resets, or reports the current status of the serving
of stale answers as configured in ``named.conf``. of stale answers as configured in ``named.conf``.
If serving of stale answers is disabled by ``rndc-serve-stale off``, If serving of stale answers is disabled by ``rndc-serve-stale off``,
@@ -415,12 +415,12 @@ Currently supported commands are:
``stale-answer-ttl`` and ``max-stale-ttl``. ``stale-answer-ttl`` and ``max-stale-ttl``.
``showzone`` *zone* [*class* [*view*]] ``showzone`` *zone* [*class* [*view*]]
This prints the configuration of a running zone. This command prints the configuration of a running zone.
See also ``rndc zonestatus``. See also ``rndc zonestatus``.
``sign`` *zone* [*class* [*view*]] ``sign`` *zone* [*class* [*view*]]
This fetches all DNSSEC keys for the given zone from the key directory (see This command fetches all DNSSEC keys for the given zone from the key directory (see
the ``key-directory`` option in the BIND 9 Administrator Reference the ``key-directory`` option in the BIND 9 Administrator Reference
Manual). If they are within their publication period, they are merged into Manual). If they are within their publication period, they are merged into
the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the
@@ -435,7 +435,7 @@ Currently supported commands are:
See also ``rndc loadkeys``. See also ``rndc loadkeys``.
``signing`` [(**-list** | **-clear** *keyid/algorithm* | **-clear** *all* | **-nsec3param** ( *parameters* | none ) | **-serial** *value* ) *zone* [*class* [*view*]] ``signing`` [(**-list** | **-clear** *keyid/algorithm* | **-clear** *all* | **-nsec3param** ( *parameters* | none ) | **-serial** *value* ) *zone* [*class* [*view*]]
This lists, edits, or removes the DNSSEC signing-state records for the This command lists, edits, or removes the DNSSEC signing-state records for the
specified zone. The status of ongoing DNSSEC operations, such as specified zone. The status of ongoing DNSSEC operations, such as
signing or generating NSEC3 chains, is stored in the zone in the form signing or generating NSEC3 chains, is stored in the zone in the form
of DNS resource records of type ``sig-signing-type``. of DNS resource records of type ``sig-signing-type``.
@@ -480,17 +480,17 @@ Currently supported commands are:
signed zones. signed zones.
``stats`` ``stats``
This writes server statistics to the statistics file. (See the This command writes server statistics to the statistics file. (See the
``statistics-file`` option in the BIND 9 Administrator Reference ``statistics-file`` option in the BIND 9 Administrator Reference
Manual.) Manual.)
``status`` ``status``
This displays the status of the server. Note that the number of zones includes This command displays the status of the server. Note that the number of zones includes
the internal ``bind/CH`` zone and the default ``./IN`` hint zone, if the internal ``bind/CH`` zone and the default ``./IN`` hint zone, if
there is no explicit root zone configured. there is no explicit root zone configured.
``stop`` **-p** ``stop`` **-p**
This stops the server, making sure any recent changes made through dynamic This command stops the server, making sure any recent changes made through dynamic
update or IXFR are first saved to the master files of the updated update or IXFR are first saved to the master files of the updated
zones. If ``-p`` is specified, ``named(8)`'s process ID is returned. zones. If ``-p`` is specified, ``named(8)`'s process ID is returned.
This allows an external process to determine when ``named`` has This allows an external process to determine when ``named`` has
@@ -499,12 +499,12 @@ Currently supported commands are:
See also ``rndc halt``. See also ``rndc halt``.
``sync`` **-clean** [*zone* [*class* [*view*]]] ``sync`` **-clean** [*zone* [*class* [*view*]]]
This syncs changes in the journal file for a dynamic zone to the master This command syncs changes in the journal file for a dynamic zone to the master
file. If the "-clean" option is specified, the journal file is also file. If the "-clean" option is specified, the journal file is also
removed. If no zone is specified, then all zones are synced. removed. If no zone is specified, then all zones are synced.
``tcp-timeouts`` [*initial* *idle* *keepalive* *advertised*] ``tcp-timeouts`` [*initial* *idle* *keepalive* *advertised*]
When called without arguments, this displays the current values of the When called without arguments, this command displays the current values of the
``tcp-initial-timeout``, ``tcp-idle-timeout``, ``tcp-initial-timeout``, ``tcp-idle-timeout``,
``tcp-keepalive-timeout``, and ``tcp-advertised-timeout`` options. ``tcp-keepalive-timeout``, and ``tcp-advertised-timeout`` options.
When called with arguments, these values are updated. This allows an When called with arguments, these values are updated. This allows an
@@ -513,7 +513,7 @@ Currently supported commands are:
Administrator Reference Manual for details of their use. Administrator Reference Manual for details of their use.
``thaw`` [*zone* [*class* [*view*]]] ``thaw`` [*zone* [*class* [*view*]]]
This enables updates to a frozen dynamic zone. If no zone is specified, This command enables updates to a frozen dynamic zone. If no zone is specified,
then all frozen zones are enabled. This causes the server to reload then all frozen zones are enabled. This causes the server to reload
the zone from disk, and re-enables dynamic updates after the load has the zone from disk, and re-enables dynamic updates after the load has
completed. After a zone is thawed, dynamic updates are no longer completed. After a zone is thawed, dynamic updates are no longer
@@ -525,31 +525,31 @@ Currently supported commands are:
See also ``rndc freeze``. See also ``rndc freeze``.
``trace`` ``trace``
This increments the server's debugging level by one. This command increments the server's debugging level by one.
``trace`` *level* ``trace`` *level*
This sets the server's debugging level to an explicit value. This command sets the server's debugging level to an explicit value.
See also ``rndc notrace``. See also ``rndc notrace``.
``tsig-delete`` *keyname* [*view*] ``tsig-delete`` *keyname* [*view*]
This deletes a given TKEY-negotiated key from the server. This does not This command deletes a given TKEY-negotiated key from the server. This does not
apply to statically configured TSIG keys. apply to statically configured TSIG keys.
``tsig-list`` ``tsig-list``
This lists the names of all TSIG keys currently configured for use by This command lists the names of all TSIG keys currently configured for use by
``named`` in each view. The list includes both statically configured keys and ``named`` in each view. The list includes both statically configured keys and
dynamic TKEY-negotiated keys. dynamic TKEY-negotiated keys.
``validation`` (**on** | **off** | **status**) [*view* ...]`` ``validation`` (**on** | **off** | **status**) [*view* ...]``
This enables, disables, or checks the current status of DNSSEC validation. By This command enables, disables, or checks the current status of DNSSEC validation. By
default, validation is enabled. default, validation is enabled.
The cache is flushed when validation is turned on or off to avoid using data The cache is flushed when validation is turned on or off to avoid using data
that might differ between states. that might differ between states.
``zonestatus`` *zone* [*class* [*view*]] ``zonestatus`` *zone* [*class* [*view*]]
This displays the current status of the given zone, including the master This command displays the current status of the given zone, including the master
file name and any include files from which it was loaded, when it was file name and any include files from which it was loaded, when it was
most recently loaded, the current serial number, the number of nodes, most recently loaded, the current serial number, the number of nodes,
whether the zone supports dynamic updates, whether the zone is DNSSEC whether the zone supports dynamic updates, whether the zone is DNSSEC

4
bin/tools/dnstap-read.rst
View File

@@ -43,7 +43,7 @@ Options
~~~~~~~ ~~~~~~~
``-m`` ``-m``
This indicates trace memory allocations, and is used for debugging memory leaks. This option indicates trace memory allocations, and is used for debugging memory leaks.
``-p`` ``-p``
This option prints the text form of the DNS This option prints the text form of the DNS
@@ -54,7 +54,7 @@ Options
of the DNS message that was encapsulated in the ``dnstap`` frame, after printing the ``dnstap`` data. of the DNS message that was encapsulated in the ``dnstap`` frame, after printing the ``dnstap`` data.
``-y`` ``-y``
This prints ``dnstap`` data in a detailed YAML format. This option prints ``dnstap`` data in a detailed YAML format.
See Also See Also
~~~~~~~~ ~~~~~~~~