1879N/A - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") 0N/A - Copyright (C) 2000-2003 Internet Software Consortium. 0N/A - Permission to use, copy, modify, and/or distribute this software for any 0N/A - purpose with or without fee is hereby granted, provided that the above 0N/A - copyright notice and this permission notice appear in all copies. 0N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 0N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 0N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 0N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 0N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 0N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 0N/A - PERFORMANCE OF THIS SOFTWARE. 1472N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1472N/A<
title>Appendix�D.�BIND 9 DNS Library Support</
title>
0N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
0N/A<
link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
0N/A<
link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
0N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0N/A<
div class="navheader">
0N/A<
table width="100%" summary="Navigation header">
0N/A<
tr><
th colspan="3" align="center">Appendix�D.�BIND 9 DNS Library Support</
th></
tr>
0N/A<
td width="20%" align="left">
0N/A<
th width="60%" align="center">�</
th>
0N/A<
div class="appendix" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h2 class="title">
0N/A<
a name="Bv9ARM.ch12"></
a>Appendix�D.�BIND 9 DNS Library Support</
h2></
div></
div></
div>
0N/A<
p><
b>Table of Contents</
b></
p>
0N/A<
dt><
span class="sect2"><
a href="Bv9ARM.ch12.html#id2613930">Sample Applications</
a></
span></
dt>
0N/A<
div class="sect1" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h2 class="title" style="clear: both">
0N/A<
p>This version of BIND 9 "exports" its internal libraries so
0N/A that they can be used by third-party applications more easily (we
0N/A call them "export" libraries in this document). In addition to
0N/A all major DNS-related APIs BIND 9 is currently using, the export
0N/A libraries provide the following features:</
p>
0N/A<
div class="itemizedlist"><
ul type="disc">
1967N/A<
li><
p>The newly created "DNS client" module. This is a higher
0N/A level API that provides an interface to name resolution,
0N/A single DNS transaction with a particular server, and dynamic
0N/A update. Regarding name resolution, it supports advanced
0N/A features such as DNSSEC validation and caching. This module
0N/A supports both synchronous and asynchronous mode.</
p></
li>
0N/A<
li><
p>The new "IRS" (Information Retrieval System) library.
0N/A file and more advanced, DNS-specific configuration file for
0N/A the rest of this package (see the description for the
0N/A<
li><
p>As part of the IRS library, newly implemented standard
0N/A address-name mapping functions, getaddrinfo() and
0N/A getnameinfo(), are provided. They use the DNSSEC-aware
0N/A validating resolver backend, and could use other advanced
0N/A features of the BIND 9 libraries such as caching. The
0N/A getaddrinfo() function resolves both A and AAAA RRs
0N/A concurrently (when the address family is unspecified).</
p></
li>
0N/A<
li><
p>An experimental framework to support other event
0N/A libraries than BIND 9's internal event task system.</
p></
li>
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
a name="id2615810"></
a>Prerequisite</
h3></
div></
div></
div>
0N/A<
p>GNU make is required to build the export libraries (other
0N/A part of BIND 9 can still be built with other types of make). In
0N/A the reminder of this document, "make" means GNU make. Note that
0N/A in some platforms you may need to invoke a different command name
0N/A than "make" (
e.g. "gmake") to indicate it's GNU make.</
p>
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
a name="id2615819"></
a>Compilation</
h3></
div></
div></
div>
0N/A$ <
strong class="userinput"><
code>/
configure --enable-exportlib <
em class="replaceable"><
code>[other flags]</
code></
em></
code></
strong>
0N/A$ <
strong class="userinput"><
code>make</
code></
strong>
0N/A This will create (in addition to usual BIND 9 programs) and a
0N/A separate set of libraries under the
lib/
export directory. For
0N/A export version of the BIND 9 DNS library. Sample application
0N/A programs using the libraries will also be built under the
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
a name="id2613796"></
a>Installation</
h3></
div></
div></
div>
0N/A$ <
strong class="userinput"><
code>cd
lib/
export</
code></
strong>
0N/A$ <
strong class="userinput"><
code>make install</
code></
strong>
0N/A This will install library object files under the directory
0N/A specified by the --with-export-libdir configure option (default:
0N/A specified by the --with-export-includedir configure option
0N/A Root privilege is normally required.
0N/A "<
span><
strong class="command">make install</
strong></
span>" at the top directory will do the
0N/A To see how to build your own
0N/A application after the installation, see
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
div class="itemizedlist"><
ul type="disc">
0N/A<
li><
p>Currently, win32 is not supported for the export
0N/A library. (Normal BIND 9 application can be built as
0N/A<
p>The "fixed" RRset order is not (currently) supported in
0N/A the export library. If you want to use "fixed" RRset order
0N/A for,
e.g. <
span><
strong class="command">named</
strong></
span> while still building the
0N/A export library even without the fixed order support, build
0N/A$ <
strong class="userinput"><
code>/
configure --enable-fixed-rrset <
em class="replaceable"><
code>[other flags, but not --enable-exportlib]</
code></
em></
code></
strong>
0N/A$ <
strong class="userinput"><
code>make</
code></
strong>
0N/A$ <
strong class="userinput"><
code>/
configure --enable-exportlib <
em class="replaceable"><
code>[other flags, but not --enable-fixed-rrset]</
code></
em></
code></
strong>
0N/A$ <
strong class="userinput"><
code>cd
lib/
export</
code></
strong>
0N/A$ <
strong class="userinput"><
code>make</
code></
strong>
0N/A<
li><
p>The client module and the IRS library currently do not
0N/A support DNSSEC validation using DLV (the underlying modules
0N/A can handle it, but there is no tunable interface to enable
0N/A the feature).</
p></
li>
0N/A<
li><
p>RFC 5011 is not supported in the validating stub
0N/A resolver of the export library. In fact, it is not clear
0N/A whether it should: trust anchors would be a system-wide
0N/A configuration which would be managed by an administrator,
0N/A while the stub resolver will be used by ordinary applications
0N/A run by a normal user.</
p></
li>
0N/A options are supported
0N/A in the IRS library. The only available options in this
0N/A version are "debug" and "ndots".</
p></
li>
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
a name="id2613904"></
a>The
dns.conf File</
h3></
div></
div></
div>
0N/A<
p>The IRS library supports an "advanced" configuration file
0N/A related to the DNS library for configuration parameters that
0N/A would be beyond the capability of the
0N/A Specifically, it is intended to provide DNSSEC related
0N/A configuration parameters. By default the path to this
0N/A experimental and the configuration syntax or library interfaces
0N/A may change in future versions. Currently, only the
0N/A <
span><
strong class="command">trusted-keys</
strong></
span>
0N/A statement is supported, whose syntax is the same as the same name
0N/A <
a href="Bv9ARM.ch06.html#trusted-keys" title="trusted-keys Statement Grammar">the section called “<
span><
strong class="command">trusted-keys</
strong></
span> Statement Grammar”</
a> for details.)</
p>
0N/A<
div class="sect2" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h3 class="title">
0N/A<
a name="id2613930"></
a>Sample Applications</
h3></
div></
div></
div>
0N/A<
p>Some sample application programs using this API are
0N/A provided for reference. The following is a brief description of
0N/A<
div class="sect3" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h4 class="title">
0N/A<
a name="id2613939"></
a>sample: a simple stub resolver utility</
h4></
div></
div></
div>
0N/A It sends a query of a given name (of a given optional RR type) to a
0N/A specified recursive server, and prints the result as a list of
0N/A RRs. It can also act as a validating stub resolver if a trust
0N/A anchor is given via a set of command line options.</
p>
0N/A Usage: sample [options] server_address hostname
0N/A Options and Arguments:
0N/A<
div class="variablelist"><
dl>
0N/A<
dt><
span class="term">
0N/A specify the RR type of the query. The default is the A RR.
0N/A<
dt><
span class="term">
0N/A [-a algorithm] [-e] -k keyname -K keystring
0N/A specify a command-line DNS key to validate the answer. For
0N/A<
div class="literallayout"><
p><
br>
0N/A specify the options as follows:
0N/A<
strong class="userinput"><
code>
0N/A -e means that this key is a zone's "key signing key" (as known
0N/A as "secure Entry point").
0N/A When -a is omitted rsasha1 will be used by default.
0N/A<
dt><
span class="term">
0N/A -s domain:alt_server_address
0N/A specify a separate recursive server address for the specific
0N/A<
dt><
span class="term">server_address</
span></
dt>
0N/A an IP(
v4/
v6) address of the recursive server to which queries
0N/A<
dt><
span class="term">hostname</
span></
dt>
0N/A the domain name for the query
0N/A<
div class="sect3" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h4 class="title">
0N/A<
a name="id2614029"></
a>sample-async: a simple stub resolver, working asynchronously</
h4></
div></
div></
div>
0N/A Similar to "sample", but accepts a list
0N/A of (query) domain names as a separate file and resolves the names
0N/A Usage: sample-async [-s server_address] [-t RR_type] input_file</
p>
0N/A Options and Arguments:
0N/A<
div class="variablelist"><
dl>
0N/A an IPv4 address of the recursive server to which queries are sent.
0N/A (IPv6 addresses are not supported in this implementation)
0N/A<
dt><
span class="term">
0N/A specify the RR type of the queries. The default is the A
0N/A<
dt><
span class="term">
0N/A a list of domain names to be resolved. each line
0N/A consists of a single domain name. Example:
0N/A <
div class="literallayout"><
p><
br>
0N/A<
div class="sect3" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h4 class="title">
0N/A<
a name="id2614083"></
a>sample-request: a simple DNS transaction client</
h4></
div></
div></
div>
0N/A It sends a query to a specified server, and
0N/A prints the response with minimal processing. It doesn't act as a
0N/A "stub resolver": it stops the processing once it gets any
0N/A response from the server, whether it's a referral or an alias
0N/A (CNAME or DNAME) that would require further queries to get the
0N/A ultimate answer. In other words, this utility acts as a very
0N/A simplified <
span><
strong class="command">dig</
strong></
span>.
562N/A Usage: sample-request [-t RRtype] server_address hostname
562N/A<
div class="variablelist"><
dl>
0N/A<
dt><
span class="term">
0N/A specify the RR type of
0N/A the queries. The default is the A RR.
0N/A<
dt><
span class="term">
0N/A address of the recursive server to which the query is sent.
0N/A<
dt><
span class="term">
0N/A the domain name for the query
0N/A<
div class="sect3" lang="en">
0N/A<
div class="titlepage"><
div><
div><
h4 class="title">
0N/A<
a name="id2614147"></
a>sample-gai: getaddrinfo() and getnameinfo() test code</
h4></
div></
div></
div>
0N/A This is a test program
0N/A to check getaddrinfo() and getnameinfo() behavior. It takes a
0N/A host name as an argument, calls getaddrinfo() with the given host
0N/A name, and calls getnameinfo() with the resulting IP addresses
0N/A returned by getaddrinfo(). If the
dns.conf file exists and
0N/A 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="sect3" lang="en">
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id2614162"></
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><
strong class="command">nsupdate</
strong></
span>.
Usage: sample-update [options] (add|delete) "update data"
<
div class="variablelist"><
dl>
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.</
div>
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="sect3" lang="en">
<
div class="titlepage"><
div><
div><
h4 class="title">
<
a name="id2615453"></
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>
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="sect2" lang="en">
<
div class="titlepage"><
div><
div><
h3 class="title">
<
a name="id2615517"></
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>
<
p style="text-align: center;">BIND 9.11.0pre-alpha</
p>