606N/A - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC") 98N/A - This Source Code Form is subject to the terms of the Mozilla Public 98N/A - License, v. 2.0. If a copy of the MPL was not distributed with this 98N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
98N/A<
title>Appendix�D.�BIND 9 DNS Library Support</
title>
98N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
98N/A<
link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
98N/A<
link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
98N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
98N/A<
div class="navheader">
98N/A<
table width="100%" summary="Navigation header">
98N/A<
tr><
th colspan="3" align="center">Appendix�D.�BIND 9 DNS Library Support</
th></
tr>
98N/A<
td width="20%" align="left">
98N/A<
th width="60%" align="center">�</
th>
98N/A<
div class="appendix">
98N/A<
div class="titlepage"><
div><
div><
h1 class="title">
98N/A<
p><
b>Table of Contents</
b></
p>
98N/A<
dt><
span class="section"><
a href="Bv9ARM.ch12.html#id-1.13.2.9">Sample Applications</
a></
span></
dt>
98N/A<
dt><
span class="section"><
a href="Bv9ARM.ch12.html#id-1.13.2.10">Library References</
a></
span></
dt>
98N/A<
div class="section">
98N/A<
div class="titlepage"><
div><
div><
h2 class="title" style="clear: both">
764N/A<
p>This version of BIND 9 "exports" its internal libraries so
98N/A that they can be used by third-party applications more easily (we
98N/A call them "export" libraries in this document). In addition to
98N/A all major DNS-related APIs BIND 9 is currently using, the export
98N/A libraries provide the following features:</
p>
98N/A<
div class="itemizedlist"><
ul class="itemizedlist" style="list-style-type: disc; ">
98N/A<
li class="listitem"><
p>The newly created "DNS client" module. This is a higher
98N/A level API that provides an interface to name resolution,
98N/A single DNS transaction with a particular server, and dynamic
199N/A update. Regarding name resolution, it supports advanced
606N/A features such as DNSSEC validation and caching. This module
98N/A supports both synchronous and asynchronous mode.</
p></
li>
98N/A<
li class="listitem"><
p>The new "IRS" (Information Retrieval System) library.
606N/A file and more advanced, DNS-specific configuration file for
257N/A the rest of this package (see the description for the
606N/A<
li class="listitem"><
p>As part of the IRS library, newly implemented standard
98N/A address-name mapping functions, getaddrinfo() and
98N/A getnameinfo(), are provided. They use the DNSSEC-aware
98N/A validating resolver backend, and could use other advanced
98N/A features of the BIND 9 libraries such as caching. The
98N/A getaddrinfo() function resolves both A and AAAA RRs
98N/A concurrently (when the address family is unspecified).</
p></
li>
98N/A<
li class="listitem"><
p>An experimental framework to support other event
98N/A libraries than BIND 9's internal event task system.</
p></
li>
98N/A<
div class="section">
606N/A<
div class="titlepage"><
div><
div><
h3 class="title">
606N/A<
a name="id-1.13.2.4"></
a>Prerequisite</
h3></
div></
div></
div>
606N/A<
p>GNU make is required to build the export libraries (other
606N/A part of BIND 9 can still be built with other types of make). In
705N/A the reminder of this document, "make" means GNU make. Note that
705N/A in some platforms you may need to invoke a different command name
705N/A than "make" (
e.g. "gmake") to indicate it's GNU make.</
p>
705N/A<
div class="titlepage"><
div><
div><
h3 class="title">
705N/A<
a name="id-1.13.2.5"></
a>Compilation</
h3></
div></
div></
div>
705N/A$ <
strong class="userinput"><
code>/
configure --enable-exportlib <
em class="replaceable"><
code>[other flags]</
code></
em></
code></
strong>
705N/A$ <
strong class="userinput"><
code>make</
code></
strong>
606N/A This will create (in addition to usual BIND 9 programs) and a
606N/A export version of the BIND 9 DNS library. Sample application
98N/A programs using the libraries will also be built under the
98N/A<
div class="section">
493N/A<
div class="titlepage"><
div><
div><
h3 class="title">
493N/A<
a name="id-1.13.2.6"></
a>Installation</
h3></
div></
div></
div>
$ <
strong class="userinput"><
code>cd
lib/
export</
code></
strong>
$ <
strong class="userinput"><
code>make install</
code></
strong>
This will install library object files under the directory
specified by the --with-export-libdir configure option (default:
specified by the --with-export-includedir configure option
Root privilege is normally required.
"<
span class="command"><
strong>make install</
strong></
span>" at the top directory will do the
To see how to build your own
application after the installation, see
<
div class="titlepage"><
div><
div><
h3 class="title">
<
div class="itemizedlist"><
ul class="itemizedlist" style="list-style-type: disc; ">
<
li class="listitem"><
p>Currently, win32 is not supported for the export
library. (Normal BIND 9 application can be built as
<
p>The "fixed" RRset order is not (currently) supported in
the export library. If you want to use "fixed" RRset order
for,
e.g. <
span class="command"><
strong>named</
strong></
span> while still building the
export library even without the fixed order support, build
$ <
strong class="userinput"><
code>/
configure --enable-fixed-rrset <
em class="replaceable"><
code>[other flags, but not --enable-exportlib]</
code></
em></
code></
strong>
$ <
strong class="userinput"><
code>make</
code></
strong>
$ <
strong class="userinput"><
code>/
configure --enable-exportlib <
em class="replaceable"><
code>[other flags, but not --enable-fixed-rrset]</
code></
em></
code></
strong>
$ <
strong class="userinput"><
code>cd
lib/
export</
code></
strong>
$ <
strong class="userinput"><
code>make</
code></
strong>
<
li class="listitem"><
p>The client module and the IRS library currently do not
support DNSSEC validation using DLV (the underlying modules
can handle it, but there is no tunable interface to enable
<
li class="listitem"><
p>RFC 5011 is not supported in the validating stub
resolver of the export library. In fact, it is not clear
whether it should: trust anchors would be a system-wide
configuration which would be managed by an administrator,
while the stub resolver will be used by ordinary applications
run by a normal user.</
p></
li>
<
li class="listitem"><
p>Not all common <
code class="filename">/
etc/
resolv.conf</
code>
in the IRS library. The only available options in this
version are "debug" and "ndots".</
p></
li>
<
div class="titlepage"><
div><
div><
h3 class="title">
<
a name="id-1.13.2.8"></
a>The
dns.conf File</
h3></
div></
div></
div>
<
p>The IRS library supports an "advanced" configuration file
related to the DNS library for configuration parameters that
would be beyond the capability of the
Specifically, it is intended to provide DNSSEC related
configuration parameters. By default the path to this
configuration file is <
code class="filename">/
etc/
dns.conf</
code>.
experimental and the configuration syntax or library interfaces
may change in future versions. Currently, only the
<
span class="command"><
strong>trusted-keys</
strong></
span>
statement is supported, whose syntax is the same as the same name
of statement for <
code class="filename">
named.conf</
code>. (See
<
a class="xref" href="Bv9ARM.ch06.html#trusted-keys" title="trusted-keys Statement Grammar">the section called “<
span class="command"><
strong>trusted-keys</
strong></
span> Statement Grammar”</
a> for details.)</
p>
<
div class="titlepage"><
div><
div><
h3 class="title">
<
a name="id-1.13.2.9"></
a>Sample Applications</
h3></
div></
div></
div>
<
p>Some sample application programs using this API are
provided for reference. The following is a brief description of
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.3"></
a>sample: a simple stub resolver utility</
h4></
div></
div></
div>
It sends a query of a given name (of a given optional RR type) to a
specified recursive server, and prints the result as a list of
RRs. It can also act as a validating stub resolver if a trust
anchor is given via a set of command line options.</
p>
Usage: sample [options] server_address hostname
<
div class="variablelist"><
dl class="variablelist">
specify the RR type of the query. The default is the A RR.
[-a algorithm] [-e] -k keyname -K keystring
specify a command-line DNS key to validate the answer. For
example, to specify the following DNSKEY of
example.com:
<
div class="literallayout"><
p><
br>
specify the options as follows:
<
strong class="userinput"><
code>
-e means that this key is a zone's "key signing key" (as known
as "secure Entry point").
When -a is omitted rsasha1 will be used by default.
-s domain:alt_server_address
specify a separate recursive server address for the specific
<
dt><
span class="term">server_address</
span></
dt>
an IP(
v4/
v6) address of the recursive server to which queries
<
dt><
span class="term">hostname</
span></
dt>
the domain name for the query
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.4"></
a>sample-async: a simple stub resolver, working asynchronously</
h4></
div></
div></
div>
Similar to "sample", but accepts a list
of (query) domain names as a separate file and resolves the names
Usage: sample-async [-s server_address] [-t RR_type] input_file</
p>
<
div class="variablelist"><
dl class="variablelist">
an IPv4 address of the recursive server to which queries are sent.
(IPv6 addresses are not supported in this implementation)
specify the RR type of the queries. The default is the A
a list of domain names to be resolved. each line
consists of a single domain name. Example:
<
div class="literallayout"><
p><
br>
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.5"></
a>sample-request: a simple DNS transaction client</
h4></
div></
div></
div>
It sends a query to a specified server, and
prints the response with minimal processing. It doesn't act as a
"stub resolver": it stops the processing once it gets any
response from the server, whether it's a referral or an alias
(CNAME or DNAME) that would require further queries to get the
ultimate answer. In other words, this utility acts as a very
simplified <
span class="command"><
strong>dig</
strong></
span>.
Usage: sample-request [-t RRtype] server_address hostname
<
div class="variablelist"><
dl class="variablelist">
the queries. The default is the A RR.
address of the recursive server to which the query is sent.
the domain name for the query
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.6"></
a>sample-gai: getaddrinfo() and getnameinfo() test code</
h4></
div></
div></
div>
to check getaddrinfo() and getnameinfo() behavior. It takes a
host name as an argument, calls getaddrinfo() with the given host
name, and calls getnameinfo() with the resulting IP addresses
returned by getaddrinfo(). If the
dns.conf file exists and
defines a trust anchor, the underlying resolver will act as a
validating resolver, and getaddrinfo()/getnameinfo() will fail
with an EAI_INSECUREDATA error when DNSSEC validation fails.
Usage: sample-gai hostname
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.7"></
a>sample-update: a simple dynamic update client program</
h4></
div></
div></
div>
It accepts a single update command as a
command-line argument, sends an update request message to the
authoritative server, and shows the response from the server. In
other words, this is a simplified <
span class="command"><
strong>nsupdate</
strong></
span>.
Usage: sample-update [options] (add|delete) "update data"
<
div class="variablelist"><
dl class="variablelist">
An IP address of the authoritative server that has authority
for the zone containing the update name. This should normally
be the primary authoritative server that accepts dynamic
updates. It can also be a secondary server that is configured
to forward update requests to the primary server.
A TSIG key file to secure the update transaction. The keyfile
format is the same as that for the nsupdate utility.
A prerequisite for the update (only one prerequisite can be
specified). The prerequisite format is the same as that is
accepted by the nsupdate utility.
An IP address of a recursive server that this utility will
use. A recursive server may be necessary to identify the
authoritative server address to which the update request is
The domain name of the zone that contains
Specify the type of update operation. Either "add" or "delete"
Specify the data to be updated. A typical example of the data
would look like "name TTL RRtype RDATA".
<
div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<
h3 class="title">Note</
h3>
In practice, either -a or -r must be specified. Others can
be optional; the underlying library routine tries to identify the
appropriate server and the zone name for the update.
Examples: assuming the primary authoritative server of the
$ <
strong class="userinput"><
code>sample-update -a sample-update -k Kxxx.+nnn+
mmmm.key add "
foo.dynamic.example.com 30 IN A 192.168.2.1"</
code></
strong></
pre>
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id-1.13.2.9.8"></
a>nsprobe:
domain/
name server checker in terms of RFC 4074</
h4></
div></
div></
div>
of domains to see the name servers of the domains behave
correctly in terms of RFC 4074. This is included in the set of
sample programs to show how the export library can be used in a
Usage: nsprobe [-d] [-v [-v...]] [-c cache_address] [input_file]
<
div class="variablelist"><
dl class="variablelist">
run in the "debug" mode. with this option nsprobe will dump
increase verbosity of other normal log messages. This can be
specify an IP address of a recursive (caching) name server.
nsprobe uses this server to get the NS RRset of each domain and
the A
and/
or AAAA RRsets for the name servers. The default
a file name containing a list of domain (zone) names to be
probed. when omitted the standard input will be used. Each
line of the input file specifies a single domain name such as
"
example.com". In general this domain name must be the apex
name of some DNS zone (unlike normal "host names" such as
the given domain name, and sends A and AAAA queries to these
servers for some "widely used" names under the zone;
specifically, adding "www" and "ftp" to the zone name.
<
div class="titlepage"><
div><
div><
h3 class="title">
<
a name="id-1.13.2.10"></
a>Library References</
h3></
div></
div></
div>
<
p>As of this writing, there is no formal "manual" of the
libraries, except this document, header files (some of them
provide pretty detailed explanations), and sample application
<
table width="100%" summary="Navigation footer">
<
td width="40%" align="left">
<
td width="20%" align="center">�</
td>
<
td width="40%" align="right">�<
a accesskey="n" href="Bv9ARM.ch13.html">Next</
a>
<
td width="40%" align="left" valign="top">Appendix�C.�General <
acronym class="acronym">DNS</
acronym> Reference Information�</
td>
<
td width="20%" align="center"><
a accesskey="h" href="Bv9ARM.html">Home</
a></
td>
<
td width="40%" align="right" valign="top">�Manual pages</
td>