Bv9ARM.ch04.html revision 60c29cf21affb5243753e22f9ff43347013ae8eb
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - purpose with or without fee is hereby granted, provided that the above
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - copyright notice and this permission notice appear in all copies.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews - PERFORMANCE OF THIS SOFTWARE.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<!-- $Id$ -->
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="prev" href="Bv9ARM.ch03.html" title="Chapter�3.�Name Server Configuration">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<link rel="next" href="Bv9ARM.ch05.html" title="Chapter�5.�The BIND 9 Lightweight Resolver">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<table width="100%" summary="Navigation header">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<tr><th colspan="3" align="center">Chapter�4.�Advanced DNS Features</th></tr>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a accesskey="p" href="Bv9ARM.ch03.html">Prev</a>�</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="20%" align="right">�<a accesskey="n" href="Bv9ARM.ch05.html">Next</a>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="Bv9ARM.ch04"></a>Chapter�4.�Advanced DNS Features</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#notify">Notify</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#dynamic_update">Dynamic Update</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dd><dl><dt><span class="sect2"><a href="Bv9ARM.ch04.html#journal">The journal file</a></span></dt></dl></dd>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#incremental_zone_transfers">Incremental Zone Transfers (IXFR)</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#id2569985">Split DNS</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dd><dl><dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570003">Example split DNS setup</a></span></dt></dl></dd>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#tsig">TSIG</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570436">Generate Shared Keys for Each Pair of Hosts</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570578">Copying the Shared Secret to Both Machines</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570588">Informing the Servers of the Key's Existence</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570625">Instructing the Server to Use the Key</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570682">TSIG Key Based Access Control</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570731">Errors</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#id2570745">TKEY</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#id2570931">SIG(0)</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#DNSSEC">DNSSEC</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2570999">Generating Keys</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2571283">Signing the Zone</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2571364">Configuring Servers</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#dnssec.dynamic.zones">DNSSEC, Dynamic Zones, and Automatic Signing</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2611910">Converting from insecure to secure</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2611947">Dynamic DNS update method</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563719">Fully automatic zone signing</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563822">Private-type records</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563860">DNSKEY rollovers</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563873">Dynamic DNS update method</a></span></dt>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563906">Automatic key rollovers</a></span></dt>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563932">NSEC3PARAM rollovers via UPDATE</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563942">Converting from NSEC to NSEC3</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2563952">Converting from NSEC3 to NSEC</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2564033">Converting from secure to insecure</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2564070">Periodic re-signing</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2564080">NSEC3 and OPTOUT</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#rfc5011.support">Dynamic Trust Anchor Management</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2612172">Validating Resolver</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2612195">Authoritative Server</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#pkcs11">PKCS#11 (Cryptoki) support</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2666563">Prerequisites</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2580010">Native PKCS#11</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2611357">OpenSSL-based PKCS#11</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2639013">PKCS#11 Tools</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2639049">Using the HSM</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2639403">Specifying the engine on the command line</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2639451">Running named with automatic zone re-signing</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#dlz-info">DLZ (Dynamically Loadable Zones)</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2639515">Configuring DLZ</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2611668">Sample DLZ Driver</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect1"><a href="Bv9ARM.ch04.html#id2571588">IPv6 Support in <acronym class="acronym">BIND</acronym> 9</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2571854">Address Lookups Using AAAA Records</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<dt><span class="sect2"><a href="Bv9ARM.ch04.html#id2571876">Address to Name Lookups Using Nibble Format</a></span></dt>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="notify"></a>Notify</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <acronym class="acronym">DNS</acronym> NOTIFY is a mechanism that allows master
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews servers to notify their slave servers of changes to a zone's data. In
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews response to a <span><strong class="command">NOTIFY</strong></span> from a master server, the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews slave will check to see that its version of the zone is the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews current version and, if not, initiate a zone transfer.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For more information about <acronym class="acronym">DNS</acronym>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">NOTIFY</strong></span>, see the description of the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">notify</strong></span> option in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called “Boolean Options”</a> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the description of the zone option <span><strong class="command">also-notify</strong></span> in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called “Zone Transfers”</a>. The <span><strong class="command">NOTIFY</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews protocol is specified in RFC 1996.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews As a slave zone can also be a master to other slaves, <span><strong class="command">named</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews by default, sends <span><strong class="command">NOTIFY</strong></span> messages for every zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews it loads. Specifying <span><strong class="command">notify master-only;</strong></span> will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cause <span><strong class="command">named</strong></span> to only send <span><strong class="command">NOTIFY</strong></span> for master
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zones that it loads.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="dynamic_update"></a>Dynamic Update</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Dynamic Update is a method for adding, replacing or deleting
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews records in a master server by sending it a special form of DNS
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews messages. The format and meaning of these messages is specified
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in RFC 2136.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Dynamic update is enabled by including an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">allow-update</strong></span> or an <span><strong class="command">update-policy</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews clause in the <span><strong class="command">zone</strong></span> statement.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If the zone's <span><strong class="command">update-policy</strong></span> is set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>local</code></strong>, updates to the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will be permitted for the key <code class="varname">local-ddns</code>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews which will be generated by <span><strong class="command">named</strong></span> at startup.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews See <a href="Bv9ARM.ch06.html#dynamic_update_policies" title="Dynamic Update Policies">the section called “Dynamic Update Policies”</a> for more details.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Dynamic updates using Kerberos signed requests can be made
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews using the TKEY/GSS protocol by setting either the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">tkey-gssapi-keytab</strong></span> option, or alternatively
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews by setting both the <span><strong class="command">tkey-gssapi-credential</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and <span><strong class="command">tkey-domain</strong></span> options. Once enabled,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Kerberos signed requests will be matched against the update
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews policies for the zone, using the Kerberos principal as the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signer for the request.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Updating of secure zones (zones using DNSSEC) follows RFC
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 3007: RRSIG, NSEC and NSEC3 records affected by updates are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews automatically regenerated by the server using an online
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone key. Update authorization is based on transaction
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signatures and an explicit server policy.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="journal"></a>The journal file</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews All changes made to a zone using dynamic update are stored
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in the zone's journal file. This file is automatically created
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews by the server when the first dynamic update takes place.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The name of the journal file is formed by appending the extension
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">.jnl</code> to the name of the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews corresponding zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews file unless specifically overridden. The journal file is in a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews binary format and should not be edited manually.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The server will also occasionally write ("dump")
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the complete contents of the updated zone to its zone file.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This is not done immediately after
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews each dynamic update, because that would be too slow when a large
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone is updated frequently. Instead, the dump is delayed by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews up to 15 minutes, allowing additional updates to take place.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews During the dump process, transient files will be created
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with the extensions <code class="filename">.jnw</code> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">.jbk</code>; under ordinary circumstances, these
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will be removed when the dump is complete, and can be safely
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When a server is restarted after a shutdown or crash, it will replay
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the journal file to incorporate into the zone any updates that
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews place after the last zone dump.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Changes that result from incoming incremental zone transfers are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews journalled in a similar way.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The zone files of dynamic zones cannot normally be edited by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews hand because they are not guaranteed to contain the most recent
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dynamic changes — those are only in the journal file.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The only way to ensure that the zone file of a dynamic zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is up to date is to run <span><strong class="command">rndc stop</strong></span>.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt If you have to make changes to a dynamic zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews manually, the following procedure will work:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Disable dynamic updates to the zone using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc freeze <em class="replaceable"><code>zone</code></em></strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This will update the zone's master file with the changes
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews stored in its <code class="filename">.jnl</code> file.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Edit the zone file. Run
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc thaw <em class="replaceable"><code>zone</code></em></strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to reload the changed zone and re-enable dynamic updates.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc sync <em class="replaceable"><code>zone</code></em></strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will update the zone file with changes from the journal file
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews without stopping dynamic updates; this may be useful for viewing
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the current zone state. To remove the <code class="filename">.jnl</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews file after updating the zone file, use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc sync -clean</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="incremental_zone_transfers"></a>Incremental Zone Transfers (IXFR)</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The incremental zone transfer (IXFR) protocol is a way for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews slave servers to transfer only changed data, instead of having to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews transfer the entire zone. The IXFR protocol is specified in RFC
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 1995. See <a href="Bv9ARM.ch09.html#proposed_standards">Proposed Standards</a>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When acting as a master, <acronym class="acronym">BIND</acronym> 9
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews supports IXFR for those zones
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews where the necessary change history information is available. These
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews include master zones maintained by dynamic update and slave zones
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews whose data was obtained by IXFR. For manually maintained master
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zones, and for slave zones obtained by performing a full zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews transfer (AXFR), IXFR is supported only if the option
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">ixfr-from-differences</strong></span> is set
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to <strong class="userinput"><code>yes</code></strong>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When acting as a slave, <acronym class="acronym">BIND</acronym> 9 will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews attempt to use IXFR unless
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews it is explicitly disabled. For more information about disabling
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews IXFR, see the description of the <span><strong class="command">request-ixfr</strong></span> clause
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of the <span><strong class="command">server</strong></span> statement.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2569985"></a>Split DNS</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Setting up different views, or visibility, of the DNS space to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews internal and external resolvers is usually referred to as a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="emphasis"><em>Split DNS</em></span> setup. There are several
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews reasons an organization would want to set up its DNS this way.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews One common reason for setting up a DNS system this way is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to hide "internal" DNS information from "external" clients on the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Internet. There is some debate as to whether or not this is actually
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Internal DNS information leaks out in many ways (via email headers,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for example) and most savvy "attackers" can find the information
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews they need using other means.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews However, since listing addresses of internal servers that
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews external clients cannot possibly reach can result in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews connection delays and other annoyances, an organization may
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews choose to use a Split DNS to present a consistent view of itself
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to the outside world.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Another common reason for setting up a Split DNS system is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to allow internal networks that are behind filters or in RFC 1918
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews space (reserved IP space, as documented in RFC 1918) to resolve DNS
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews on the Internet. Split DNS can also be used to allow mail from outside
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews back in to the internal network.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570003"></a>Example split DNS setup</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Let's say a company named <span class="emphasis"><em>Example, Inc.</em></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews has several corporate sites that have an internal network with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Internet Protocol (IP) space and an external demilitarized zone (DMZ),
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or "outside" section of a network, that is available to the public.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="emphasis"><em>Example, Inc.</em></span> wants its internal clients
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to be able to resolve external hostnames and to exchange mail with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews people on the outside. The company also wants its internal resolvers
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to have access to certain internal-only zones that are not available
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews at all outside of the internal network.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In order to accomplish this, the company will set up two sets
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of name servers. One set will be on the inside network (in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews IP space) and the other set will be on bastion hosts, which are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews hosts that can talk to both sides of its network, in the DMZ.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The internal servers will be configured to forward all queries,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews except queries for <code class="filename">site1.internal</code>, <code class="filename">site2.internal</code>, <code class="filename">site1.example.com</code>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and <code class="filename">site2.example.com</code>, to the servers
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt DMZ. These internal servers will have complete sets of information
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for <code class="filename">site1.example.com</code>, <code class="filename">site2.example.com</code>, <code class="filename">site1.internal</code>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and <code class="filename">site2.internal</code>.
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt To protect the <code class="filename">site1.internal</code> and <code class="filename">site2.internal</code> domains,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the internal name servers must be configured to disallow all queries
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to these domains from any external hosts, including the bastion
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The external servers, which are on the bastion hosts, will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be configured to serve the "public" version of the <code class="filename">site1</code> and <code class="filename">site2.example.com</code> zones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This could include things such as the host records for public servers
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (<code class="filename">www.example.com</code> and <code class="filename">ftp.example.com</code>),
1bb2f53b9f74a8ca9812cbe9243ef41190b4da14Evan Hunt and mail exchange (MX) records (<code class="filename">a.mx.example.com</code> and <code class="filename">b.mx.example.com</code>).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In addition, the public <code class="filename">site1</code> and <code class="filename">site2.example.com</code> zones
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews should have special MX records that contain wildcard (`*') records
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews pointing to the bastion hosts. This is needed because external mail
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews servers do not have any other way of looking up how to deliver mail
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to those internal hosts. With the wildcard records, the mail will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be delivered to the bastion host, which can then forward it on to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews internal hosts.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Here's an example of a wildcard MX record:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<pre class="programlisting">* IN MX 10 external1.example.com.</pre>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Now that they accept mail on behalf of anything in the internal
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews network, the bastion hosts will need to know how to deliver mail
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to internal hosts. In order for this to work properly, the resolvers
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the bastion hosts will need to be configured to point to the internal
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews name servers for DNS resolution.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Queries for internal hostnames will be answered by the internal
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews servers, and queries for external hostnames will be forwarded back
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews out to the DNS servers on the bastion hosts.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In order for all this to work properly, internal clients will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews need to be configured to query <span class="emphasis"><em>only</em></span> the internal
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews name servers for DNS queries. This could also be enforced via
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews filtering on the network.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If everything has been set properly, <span class="emphasis"><em>Example, Inc.</em></span>'s
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews internal clients will now be able to:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Look up any hostnames in the <code class="literal">site1</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">site2.example.com</code> zones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Look up any hostnames in the <code class="literal">site1.internal</code> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">site2.internal</code> domains.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<li>Exchange mail with both internal and external people.</li>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Hosts on the Internet will be able to:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Look up any hostnames in the <code class="literal">site1</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">site2.example.com</code> zones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Exchange mail with anyone in the <code class="literal">site1</code> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">site2.example.com</code> zones.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt Here is an example configuration for the setup we just
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt described above. Note that this is only configuration information;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for information on how to configure your zone files, see <a href="Bv9ARM.ch03.html#sample_configuration" title="Sample Configurations">the section called “Sample Configurations”</a>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Internal DNS server config:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsacl internals { 172.16.72.0/24; 192.168.1.0/24; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsacl externals { <code class="varname">bastion-ips-go-here</code>; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forward only;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // forward to external servers
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forwarders {
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="varname">bastion-ips-go-here</code>;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // sample allow-transfer (no one)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { none; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // restrict query access
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // restrict recursion
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-recursion { internals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews// sample master zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews type master;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // do normal iterative resolution (do not forward)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forwarders { };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { internals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews// sample slave zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews masters { 172.16.72.3; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forwarders { };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { internals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews type master;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forwarders { };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { internals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { internals; }
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews masters { 172.16.72.3; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forwarders { };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { internals };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { internals; }
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews External (bastion host) DNS server config:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsacl internals { 172.16.72.0/24; 192.168.1.0/24; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsacl externals { bastion-ips-go-here; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // sample allow-transfer (no one)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { none; };
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt // default query access
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query { any; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // restrict cache access
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-query-cache { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews // restrict recursion
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-recursion { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews// sample slave zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews type master;
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt allow-transfer { internals; externals; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews masters { another_bastion_host_maybe; };
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews allow-transfer { internals; externals; }
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In the <code class="filename">resolv.conf</code> (or equivalent) on
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the bastion host(s):
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsnameserver 172.16.72.2
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsnameserver 172.16.72.3
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsnameserver 172.16.72.4
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This is a short guide to setting up Transaction SIGnatures
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (TSIG) based transaction security in <acronym class="acronym">BIND</acronym>. It describes changes
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to the configuration file as well as what changes are required for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews different features, including the process of creating transaction
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews keys and using transaction signatures with <acronym class="acronym">BIND</acronym>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <acronym class="acronym">BIND</acronym> primarily supports TSIG for server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to server communication.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This includes zone transfer, notify, and recursive query messages.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Resolvers based on newer versions of <acronym class="acronym">BIND</acronym> 8 have limited support
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews TSIG can also be useful for dynamic update. A primary
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews server for a dynamic zone should control access to the dynamic
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews update service, but IP-based access control is insufficient.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The cryptographic access control provided by TSIG
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is far superior. The <span><strong class="command">nsupdate</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews program supports TSIG via the <code class="option">-k</code> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="option">-y</code> command line options or inline by use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of the <span><strong class="command">key</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570436"></a>Generate Shared Keys for Each Pair of Hosts</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews A shared secret is generated to be shared between <span class="emphasis"><em>host1</em></span> and <span class="emphasis"><em>host2</em></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews An arbitrary key name is chosen: "host1-host2.". The key name must
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be the same on both hosts.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570521"></a>Automatic Generation</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The following command will generate a 128-bit (16 byte) HMAC-SHA256
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews key as described above. Longer keys are better, but shorter keys
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are easier to read. Note that the maximum key length is the digest
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews length, here 256 bits.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>dnssec-keygen -a hmac-sha256 -b 128 -n HOST host1-host2.</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The key is in the file <code class="filename">Khost1-host2.+163+00000.private</code>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Nothing directly uses this file, but the base-64 encoded string
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews can be extracted from the file and used as a shared secret:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<pre class="programlisting">Key: La/E5CjG9O+os1jq0a2jdA==</pre>
f03747965c663e5d21af52dd111460efea9e8dd7Francis Dupont The string "<code class="literal">La/E5CjG9O+os1jq0a2jdA==</code>" can
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be used as the shared secret.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570560"></a>Manual Generation</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The shared secret is simply a random sequence of bits, encoded
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in base-64. Most ASCII strings are valid base-64 strings (assuming
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the length is a multiple of 4 and only valid characters are used),
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews so the shared secret can be manually generated.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Also, a known string can be run through <span><strong class="command">mmencode</strong></span> or
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a similar program to generate base-64 encoded data.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570578"></a>Copying the Shared Secret to Both Machines</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This is beyond the scope of DNS. A secure transport mechanism
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews should be used. This could be secure FTP, ssh, telephone, etc.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570588"></a>Informing the Servers of the Key's Existence</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Imagine <span class="emphasis"><em>host1</em></span> and <span class="emphasis"><em>host 2</em></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews both servers. The following is added to each server's <code class="filename">named.conf</code> file:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewskey host1-host2. {
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews algorithm hmac-sha256;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The secret is the one generated above. Since this is a secret, it
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is recommended that either <code class="filename">named.conf</code> be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews non-world readable, or the key directive be added to a non-world
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews readable file that is included by <code class="filename">named.conf</code>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews At this point, the key is recognized. This means that if the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews server receives a message signed by this key, it can verify the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signature. If the signature is successfully verified, the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews response is signed by the same key.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570625"></a>Instructing the Server to Use the Key</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Since keys are shared between two hosts only, the server must
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be told when keys are to be used. The following is added to the <code class="filename">named.conf</code> file
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for <span class="emphasis"><em>host1</em></span>, if the IP address of <span class="emphasis"><em>host2</em></span> is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsserver 10.1.2.3 {
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews keys { host1-host2. ;};
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Multiple keys may be present, but only the first is used.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This directive does not contain any secrets, so it may be in a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews world-readable
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If <span class="emphasis"><em>host1</em></span> sends a message that is a request
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to that address, the message will be signed with the specified key. <span class="emphasis"><em>host1</em></span> will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews expect any responses to signed messages to be signed with the same
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt A similar statement must be present in <span class="emphasis"><em>host2</em></span>'s
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt configuration file (with <span class="emphasis"><em>host1</em></span>'s address) for <span class="emphasis"><em>host2</em></span> to
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt sign request messages to <span class="emphasis"><em>host1</em></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570682"></a>TSIG Key Based Access Control</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <acronym class="acronym">BIND</acronym> allows IP addresses and ranges
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to be specified in ACL
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews definitions and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">allow-{ query | transfer | update }</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This has been extended to allow TSIG keys also. The above key would
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be denoted <span><strong class="command">key host1-host2.</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews An example of an <span><strong class="command">allow-update</strong></span> directive would be:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsallow-update { key host1-host2. ;};
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This allows dynamic updates to succeed only if the request
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews was signed by a key named "<span><strong class="command">host1-host2.</strong></span>".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews See <a href="Bv9ARM.ch06.html#dynamic_update_policies" title="Dynamic Update Policies">the section called “Dynamic Update Policies”</a> for a discussion of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the more flexible <span><strong class="command">update-policy</strong></span> statement.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570731"></a>Errors</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The processing of TSIG signed messages can result in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews several errors. If a signed message is sent to a non-TSIG aware
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews server, a FORMERR (format error) will be returned, since the server will not
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews understand the record. This is a result of misconfiguration,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews since the server must be explicitly configured to send a TSIG
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signed message to a specific server.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If a TSIG aware server receives a message signed by an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews unknown key, the response will be unsigned with the TSIG
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews extended error code set to BADKEY. If a TSIG aware server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews receives a message with a signature that does not validate, the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews response will be unsigned with the TSIG extended error code set
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to BADSIG. If a TSIG aware server receives a message with a time
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews outside of the allowed range, the response will be signed with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the TSIG extended error code set to BADTIME, and the time values
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will be adjusted so that the response can be successfully
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews verified. In any of these cases, the message's rcode (response code) is set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews NOTAUTH (not authenticated).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570745"></a>TKEY</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span><strong class="command">TKEY</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is a mechanism for automatically generating a shared secret
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews between two hosts. There are several "modes" of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> that specify how the key is generated
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or assigned. <acronym class="acronym">BIND</acronym> 9 implements only one of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews these modes, the Diffie-Hellman key exchange. Both hosts are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews required to have a Diffie-Hellman KEY record (although this
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record is not required to be present in a zone). The
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> process must use signed messages,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signed either by TSIG or SIG(0). The result of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> is a shared secret that can be used to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews sign messages with TSIG. <span><strong class="command">TKEY</strong></span> can also be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews used to delete shared secrets that it had previously
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <span><strong class="command">TKEY</strong></span> process is initiated by a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or server by sending a signed <span><strong class="command">TKEY</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (including any appropriate KEYs) to a TKEY-aware server. The
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews server response, if it indicates success, will contain a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> record and any appropriate keys.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this exchange, both participants have enough information to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews determine the shared secret; the exact process depends on the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> mode. When using the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Diffie-Hellman
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">TKEY</strong></span> mode, Diffie-Hellman keys are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and the shared secret is derived by both participants.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2570931"></a>SIG(0)</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <acronym class="acronym">BIND</acronym> 9 partially supports DNSSEC SIG(0)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews transaction signatures as specified in RFC 2535 and RFC 2931.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews uses public/private keys to authenticate messages. Access control
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is performed in the same manner as TSIG keys; privileges can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews granted or denied based on the key name.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When a SIG(0) signed message is received, it will only be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews verified if the key is known and trusted by the server; the server
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will not attempt to locate and/or validate the key.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews SIG(0) signing of multiple-message TCP streams is not
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The only tool shipped with <acronym class="acronym">BIND</acronym> 9 that
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews generates SIG(0) signed messages is <span><strong class="command">nsupdate</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="DNSSEC"></a>DNSSEC</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Cryptographic authentication of DNS information is possible
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews through the DNS Security (<span class="emphasis"><em>DNSSEC-bis</em></span>) extensions,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews defined in RFC 4033, RFC 4034, and RFC 4035.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This section describes the creation and use of DNSSEC signed zones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In order to set up a DNSSEC secure zone, there are a series
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of steps which must be followed. <acronym class="acronym">BIND</acronym>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with several tools
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews that are used in this process, which are explained in more detail
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews below. In all cases, the <code class="option">-h</code> option prints a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews full list of parameters. Note that the DNSSEC tools require the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews keyset files to be in the working directory or the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews directory specified by the <code class="option">-d</code> option, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews that the tools shipped with BIND 9.2.x and earlier are not compatible
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with the current ones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews There must also be communication with the administrators of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the parent and/or child zone to transmit keys. A zone's security
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews status must be indicated by the parent zone for a DNSSEC capable
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews resolver to trust its data. This is done through the presence
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or absence of a <code class="literal">DS</code> record at the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For other servers to trust data in this zone, they must
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews either be statically configured with this zone's zone key or the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone key of another zone above this one in the DNS tree.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt<a name="id2570999"></a>Generating Keys</h3></div></div></div>
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt The <span><strong class="command">dnssec-keygen</strong></span> program is used to
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt generate keys.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews A secure zone must contain one or more zone keys. The
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone keys will sign all other records in the zone, as well as
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the zone keys of any secure delegated zones. Zone keys must
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews have the same name as the zone, a name type of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">ZONE</strong></span>, and must be usable for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews authentication.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews It is recommended that zone keys use a cryptographic algorithm
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews designated as "mandatory to implement" by the IETF; currently
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the only one is RSASHA1.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The following command will generate a 768-bit RSASHA1 key for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the <code class="filename">child.example</code> zone:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>dnssec-keygen -a RSASHA1 -b 768 -n ZONE child.example.</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Two output files will be produced:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">Kchild.example.+005+12345.key</code> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">Kchild.example.+005+12345.private</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 12345 is an example of a key tag). The key filenames contain
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the key name (<code class="filename">child.example.</code>),
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews algorithm (3
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is DSA, 1 is RSAMD5, 5 is RSASHA1, etc.), and the key tag (12345 in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The private key (in the <code class="filename">.private</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews used to generate signatures, and the public key (in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">.key</code> file) is used for signature
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews verification.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To generate another key with the same properties (but with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a different key tag), repeat the above command.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <span><strong class="command">dnssec-keyfromlabel</strong></span> program is used
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to get a key pair from a crypto hardware and build the key
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews files. Its usage is similar to <span><strong class="command">dnssec-keygen</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The public keys should be inserted into the zone file by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews including the <code class="filename">.key</code> files using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">$INCLUDE</strong></span> statements.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2571283"></a>Signing the Zone</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <span><strong class="command">dnssec-signzone</strong></span> program is used
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to sign a zone.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt Any <code class="filename">keyset</code> files corresponding to
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt secure subzones should be present. The zone signer will
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt generate <code class="literal">NSEC</code>, <code class="literal">NSEC3</code>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt and <code class="literal">RRSIG</code> records for the zone, as
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt well as <code class="literal">DS</code> for the child zones if
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">'-g'</code> is specified. If <code class="literal">'-g'</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is not specified, then DS RRsets for the secure child
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zones need to be added manually.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The following command signs the zone, assuming it is in a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews file called <code class="filename">zone.child.example</code>. By
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews default, all zone keys which have an available private key are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews used to generate signatures.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>dnssec-signzone -o child.example zone.child.example</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews One output file is produced:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">zone.child.example.signed</code>. This
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews should be referenced by <code class="filename">named.conf</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews input file for the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p><span><strong class="command">dnssec-signzone</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will also produce a keyset and dsset files and optionally a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dlvset file. These are used to provide the parent zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews administrators with the <code class="literal">DNSKEYs</code> (or their
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews corresponding <code class="literal">DS</code> records) that are the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews secure entry point to the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2571364"></a>Configuring Servers</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To enable <span><strong class="command">named</strong></span> to respond appropriately
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to DNS requests from DNSSEC aware clients,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-enable</strong></span> must be set to yes.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (This is the default setting.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To enable <span><strong class="command">named</strong></span> to validate answers from
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews other servers, the <span><strong class="command">dnssec-enable</strong></span> option
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews must be set to <strong class="userinput"><code>yes</code></strong>, and the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-validation</strong></span> options must be set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>yes</code></strong> or <strong class="userinput"><code>auto</code></strong>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If <span><strong class="command">dnssec-validation</strong></span> is set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>auto</code></strong>, then a default
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews trust anchor for the DNS root zone will be used.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If it is set to <strong class="userinput"><code>yes</code></strong>, however,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews then at least one trust anchor must be configured
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with a <span><strong class="command">trusted-keys</strong></span> or
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">managed-keys</strong></span> statement in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">named.conf</code>, or DNSSEC validation
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will not occur. The default setting is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>yes</code></strong>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">trusted-keys</strong></span> are copies of DNSKEY RRs
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for zones that are used to form the first link in the
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt cryptographic chain of trust. All keys listed in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">trusted-keys</strong></span> (and corresponding zones)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are deemed to exist and only the listed keys will be used
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to validated the DNSKEY RRset that they are from.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">managed-keys</strong></span> are trusted keys which are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews automatically kept up to date via RFC 5011 trust anchor
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews maintenance.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">trusted-keys</strong></span> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">managed-keys</strong></span> are described in more detail
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews later in this document.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Unlike <acronym class="acronym">BIND</acronym> 8, <acronym class="acronym">BIND</acronym>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 9 does not verify signatures on load, so zone keys for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews authoritative zones do not need to be specified in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configuration file.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews After DNSSEC gets established, a typical DNSSEC configuration
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will look something like the following. It has one or
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews more public keys for the root. This allows answers from
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews outside the organization to be validated. It will also
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews have several keys for parts of the namespace the organization
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews controls. These are here to ensure that <span><strong class="command">named</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is immune to compromises in the DNSSEC components of the security
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of parent zones.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsmanaged-keys {
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews /* Root Key */
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "." initial-key 257 3 3 "BNY4wrWM1nCfJ+CXd0rVXyYmobt7sEEfK3clRbGaTwS
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 66gKodQj+MiA21AfUVe7u99WzTLzY3qlxDhxYQQ20FQ
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dgxbcDTClU0CRBdiieyLMNzXG3";
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunttrusted-keys {
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt /* Key for our organization's forward zone */
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt example.com. 257 3 5 "AwEAAaxPMcR2x0HbQV4WeZB6oEDX+r0QM6
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt 5KbhTjrW1ZaARmPhEZZe3Y9ifgEuq7vZ/z
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt GZUdEGNWy+JZzus0lUptwgjGwhUS1558Hb
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt 4JKUbbOTcM8pwXlj0EiX3oDFVmjHO444gL
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt g4ywzO9WglMk7jbfW33gUKvirTHr25GL7S
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt TQUzBb5Usxt8lgnyTUHs1t3JwCY5hKZ6Cq
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt F4qJCyduieHukuY3H4XMAcR+xia2nIUPvm
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt /* Key for our reverse zone. */
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt 2.0.192.IN-ADDRPA.NET. 257 3 5 "AQOnS4xn/IgOUpBPJ3bogzwc
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt xOdNax071L18QqZnQQQAVVr+i
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt LhGTnNGp3HoWQLUIzKrJVZ3zg
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt gy3WwNT6kZo6c0tszYqbtvchm
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt siaOdS0yOI6BgPsw+YZdzlYMa
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt IJGf4M4dyoKIhzdZyQ2bYQrjy
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt Q4LB0lC7aOnsMyYKHHYeRvPxj
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt IQXmdqgOJGq+vsevG06zW+1xg
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt 59VvjSPsZJHeDCUyWYrvPZesZ
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt DIRvhDD52SKvbheeTJUm6Ehkz
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt dnssec-enable yes;
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt dnssec-validation yes;
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt None of the keys listed in this example are valid. In particular,
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt the root key is not valid.
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt When DNSSEC validation is enabled and properly configured,
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt the resolver will reject any answers from signed, secure zones
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt which fail to validate, and will return SERVFAIL to the client.
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt Responses may fail to validate for any of several reasons,
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt including missing, expired, or invalid signatures, a key which
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt does not match the DS RRset in the parent zone, or an insecure
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt response from a zone which, according to its parent, should have
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt been secure.
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt When the validator receives a response from an unsigned zone
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt that has a signed parent, it must confirm with the parent
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt that the zone was intentionally left unsigned. It does
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt this by verifying, via signed and validated NSEC/NSEC3 records,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews that the parent zone contains no DS records for the child.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If the validator <span class="emphasis"><em>can</em></span> prove that the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is insecure, then the response is accepted. However, if it
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cannot, then it must assume an insecure response to be a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews forgery; it rejects the response and logs an error.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The logged error reads "insecurity proof failed" and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "got insecure response; parent indicates it should be secure".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (Prior to BIND 9.7, the logged error was "not insecure".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This referred to the zone, not the response.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="dnssec.dynamic.zones"></a>DNSSEC, Dynamic Zones, and Automatic Signing</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>As of BIND 9.7.0 it is possible to change a dynamic zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews from insecure to signed and back again. A secure zone can use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews either NSEC or NSEC3 chains.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2611910"></a>Converting from insecure to secure</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Changing a zone from insecure to secure can be done in two
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews ways: using a dynamic DNS update, or the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec</strong></span> zone option.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>For either method, you need to configure
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> so that it can see the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">K*</code> files which contain the public and private
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews parts of the keys that will be used to sign the zone. These files
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will have been generated by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keygen</strong></span>. You can do this by placing them
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in the key-directory, as specified in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews type master;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews update-policy local;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>If one KSK and one ZSK DNSKEY key have been generated, this
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configuration will cause all records in the zone to be signed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with the ZSK, and the DNSKEY RRset to be signed with the KSK as
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews well. An NSEC chain will be generated as part of the initial
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signing process.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2611947"></a>Dynamic DNS update method</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > ttl 3600
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > update add example.net DNSKEY 257 3 7 AwEAAd/7odU/64o2LGsifbLtQmtO8dFDtTAZXSX2+X3e/UNlq9IHq3Y0 XtC0Iuawl/qkaKVxXe2lo8Ct+dM6UehyCqk=
1bb2f53b9f74a8ca9812cbe9243ef41190b4da14Evan Hunt<p>While the update request will complete almost immediately,
1bb2f53b9f74a8ca9812cbe9243ef41190b4da14Evan Hunt the zone will not be completely signed until
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> has had time to walk the zone and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews generate the NSEC and RRSIG records. The NSEC record at the apex
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will be added last, to signal that there is a complete NSEC
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>If you wish to sign using NSEC3 instead of NSEC, you should
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews add an NSEC3PARAM record to the initial update request. If you
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews wish the NSEC3 chain to have the OPTOUT bit set, set it in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews flags field of the NSEC3PARAM record.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > ttl 3600
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > update add example.net DNSKEY 257 3 7 AwEAAd/7odU/64o2LGsifbLtQmtO8dFDtTAZXSX2+X3e/UNlq9IHq3Y0 XtC0Iuawl/qkaKVxXe2lo8Ct+dM6UehyCqk=
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews > update add example.net NSEC3PARAM 1 1 100 1234567890
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Again, this update request will complete almost
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews immediately; however, the record won't show up until
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> has had a chance to build/remove the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews relevant chain. A private type record will be created to record
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the state of the operation (see below for more details), and will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be removed once the operation completes.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>While the initial signing and NSEC/NSEC3 chain generation
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is happening, other updates are possible as well.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563719"></a>Fully automatic zone signing</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To enable automatic signing, add the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec</strong></span> option to the zone statement in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec</strong></span> has two possible arguments:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec allow</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> can search the key directory for keys
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews matching the zone, insert them into the zone, and use them to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews sign the zone. It will do so only when it receives an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc sign <zonename></strong></span>.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec maintain</strong></span> includes the above
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews functionality, but will also automatically adjust the zone's
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DNSKEY records on schedule according to the keys' timing metadata.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (See <a href="man.dnssec-keygen.html" title="dnssec-keygen"><span class="refentrytitle"><span class="application">dnssec-keygen</span></span>(8)</a> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <a href="man.dnssec-settime.html" title="dnssec-settime"><span class="refentrytitle"><span class="application">dnssec-settime</span></span>(8)</a> for more information.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> will periodically search the key directory
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for keys matching the zone, and if the keys' metadata indicates
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews that any change should be made the zone, such as adding, removing,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews or revoking a key, then that action will be carried out. By default,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the key directory is checked for changes every 60 minutes; this period
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews can be adjusted with the <code class="option">dnssec-loadkeys-interval</code>, up
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to a maximum of 24 hours. The <span><strong class="command">rndc loadkeys</strong></span> forces
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> to check for key updates immediately.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If keys are present in the key directory the first time the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is loaded, the zone will be signed immediately, without waiting for an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">rndc sign</strong></span> or <span><strong class="command">rndc loadkeys</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews command. (Those commands can still be used when there are unscheduled
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews key changes, however.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If you wish the zone to be signed using NSEC3 instead of NSEC,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews submit an NSEC3PARAM record via dynamic update prior to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews scheduled publication and activation of the keys. If you wish the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews NSEC3 chain to have the OPTOUT bit set, set it in the flags field
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of the NSEC3PARAM record. The NSEC3PARAM record will not appear in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the zone immediately, but it will be stored for later reference. When
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the zone is signed and the NSEC3 chain is completed, the NSEC3PARAM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record will appear in the zone.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec</strong></span> option requires the zone to be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configured to allow dynamic updates, by adding an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">allow-update</strong></span> or
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">update-policy</strong></span> statement to the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configuration. If this has not been done, the configuration will
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<a name="id2563822"></a>Private-type records</h3></div></div></div></div>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<p>The state of the signing process is signaled by
651878e16668d1809562813020c298cf9eed7184Francis Dupont private-type records (with a default type value of 65534). When
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt signing is complete, these records will have a nonzero value for
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt the final octet (for those records which have a nonzero initial
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<p>The private type record format: If the first octet is
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt non-zero then the record indicates that the zone needs to be
651878e16668d1809562813020c298cf9eed7184Francis Dupont signed with the key matching the record, or that all signatures
651878e16668d1809562813020c298cf9eed7184Francis Dupont that match the record should be removed.</p>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��algorithm�(octet�1)<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��key�id�in�network�order�(octet�2�and�3)<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��removal�flag�(octet�4)<br>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt��complete�flag�(octet�5)<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont<p>Only records flagged as "complete" can be removed via
651878e16668d1809562813020c298cf9eed7184Francis Dupont dynamic update. Attempts to remove other private type records
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt will be silently ignored.</p>
651878e16668d1809562813020c298cf9eed7184Francis Dupont<p>If the first octet is zero (this is a reserved algorithm
651878e16668d1809562813020c298cf9eed7184Francis Dupont number that should never appear in a DNSKEY record) then the
651878e16668d1809562813020c298cf9eed7184Francis Dupont record indicates changes to the NSEC3 chains are in progress. The
651878e16668d1809562813020c298cf9eed7184Francis Dupont rest of the record contains an NSEC3PARAM record. The flag field
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt tells what operation to perform based on the flag bits.</p>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt��0x01�OPTOUT<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��0x80�CREATE<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��0x40�REMOVE<br>
651878e16668d1809562813020c298cf9eed7184Francis Dupont��0x20�NONSEC<br>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563860"></a>DNSKEY rollovers</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>As with insecure-to-secure conversions, rolling DNSSEC
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews keys can be done in two ways: using a dynamic DNS update, or the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">auto-dnssec</strong></span> zone option.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563873"></a>Dynamic DNS update method</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p> To perform key rollovers via dynamic update, you need to add
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the <code class="filename">K*</code> files for the new keys so that
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> can find them. You can then add the new
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DNSKEY RRs via dynamic update.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> will then cause the zone to be signed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with the new keys. When the signing is complete the private type
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews records will be updated so that the last octet is non
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>If this is for a KSK you need to inform the parent and any
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews trust anchor repositories of the new KSK.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>You should then wait for the maximum TTL in the zone before
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews removing the old DNSKEY. If it is a KSK that is being updated,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews you also need to wait for the DS RRset in the parent to be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews updated and its TTL to expire. This ensures that all clients will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be able to verify at least one signature when you remove the old
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>The old DNSKEY can be removed via UPDATE. Take care to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews specify the correct key.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> will clean out any signatures generated
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews by the old key after the update completes.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563906"></a>Automatic key rollovers</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>When a new key reaches its activation date (as set by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keygen</strong></span> or <span><strong class="command">dnssec-settime</strong></span>),
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews if the <span><strong class="command">auto-dnssec</strong></span> zone option is set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="constant">maintain</code>, <span><strong class="command">named</strong></span> will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews automatically carry out the key rollover. If the key's algorithm
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews has not previously been used to sign the zone, then the zone will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews be fully signed as quickly as possible. However, if the new key
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is replacing an existing key of the same algorithm, then the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone will be re-signed incrementally, with signatures from the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews old key being replaced with signatures from the new key as their
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signature validity periods expire. By default, this rollover
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews completes in 30 days, after which it will be safe to remove the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews old key from the DNSKEY RRset.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563932"></a>NSEC3PARAM rollovers via UPDATE</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Add the new NSEC3PARAM record via dynamic update. When the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews new NSEC3 chain has been generated, the NSEC3PARAM flag field
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will be zero. At this point you can remove the old NSEC3PARAM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record. The old chain will be removed after the update request
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews completes.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563942"></a>Converting from NSEC to NSEC3</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To do this, you just need to add an NSEC3PARAM record. When
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the conversion is complete, the NSEC chain will have been removed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and the NSEC3PARAM record will have a zero flag field. The NSEC3
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews chain will be generated before the NSEC chain is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews destroyed.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2563952"></a>Converting from NSEC3 to NSEC</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To do this, use <span><strong class="command">nsupdate</strong></span> to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews remove all NSEC3PARAM records with a zero flag
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews field. The NSEC chain will be generated before the NSEC3 chain is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews removed.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2564033"></a>Converting from secure to insecure</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To convert a signed zone to unsigned using dynamic DNS,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews delete all the DNSKEY records from the zone apex using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">nsupdate</strong></span>. All signatures, NSEC or NSEC3 chains,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and associated NSEC3PARAM records will be removed automatically.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This will take place after the update request completes.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p> This requires the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-secure-to-insecure</strong></span> option to be set to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>yes</code></strong> in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>In addition, if the <span><strong class="command">auto-dnssec maintain</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone statement is used, it should be removed or changed to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">allow</strong></span> instead (or it will re-sign).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2564070"></a>Periodic re-signing</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>In any secure zone which supports dynamic updates, named
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews will periodically re-sign RRsets which have not been re-signed as
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a result of some update action. The signature lifetimes will be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews adjusted so as to spread the re-sign load over time rather than
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews all at once.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2564080"></a>NSEC3 and OPTOUT</h3></div></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> only supports creating new NSEC3 chains
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews where all the NSEC3 records in the zone have the same OPTOUT
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> supports UPDATES to zones where the NSEC3
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt records in the chain have mixed OPTOUT state.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> does not support changing the OPTOUT
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews state of an individual NSEC3 record, the entire chain needs to be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews changed if the OPTOUT state of an individual NSEC3 needs to be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews changed.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="rfc5011.support"></a>Dynamic Trust Anchor Management</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>BIND 9.7.0 introduces support for RFC 5011, dynamic trust
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews anchor management. Using this feature allows
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span> to keep track of changes to critical
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DNSSEC keys without any need for the operator to make changes to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configuration files.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612172"></a>Validating Resolver</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To configure a validating resolver to use RFC 5011 to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews maintain a trust anchor, configure the trust anchor using a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">managed-keys</strong></span> statement. Information about
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this can be found in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <a href="Bv9ARM.ch06.html#managed-keys" title="managed-keys Statement Definition
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and Usage">the section called “<span><strong class="command">managed-keys</strong></span> Statement Definition
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612195"></a>Authoritative Server</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To set up an authoritative zone for RFC 5011 trust anchor
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews maintenance, generate two (or more) key signing keys (KSKs) for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the zone. Sign the zone with one of them; this is the "active"
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews KSK. All KSK's which do not sign the zone are "stand-by"
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Any validating resolver which is configured to use the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews active KSK as an RFC 5011-managed trust anchor will take note
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of the stand-by KSKs in the zone's DNSKEY RRset, and store them
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for future reference. The resolver will recheck the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews periodically, and after 30 days, if the new key is still there,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews then the key will be accepted by the resolver as a valid trust
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews anchor for the zone. Any time after this 30-day acceptance
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews timer has completed, the active KSK can be revoked, and the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone can be "rolled over" to the newly accepted key.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>The easiest way to place a stand-by key in a zone is to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews use the "smart signing" features of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keygen</strong></span> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-signzone</strong></span>. If a key with a publication
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews date in the past, but an activation date which is unset or in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the future, "
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-signzone -S</strong></span>" will include the DNSKEY
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record in the zone, but will not sign with it:</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-keygen -K keys -f KSK -P now -A now+2y example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-signzone -S -K keys example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>To revoke a key, the new command
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-revoke</strong></span> has been added. This adds the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews REVOKED bit to the key flags and re-generates the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">K*.private</code> files.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>After revoking the active key, the zone must be signed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with both the revoked KSK and the new active KSK. (Smart
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews signing takes care of this automatically.)</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Once a key has been revoked and used to sign the DNSKEY
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews RRset in which it appears, that key will never again be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews accepted as a valid trust anchor by the resolver. However,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews validation can proceed using the new active key (which had been
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews accepted by the resolver when it was a stand-by key).</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>See RFC 5011 for more details on key rollover
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews scenarios.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>When a key has been revoked, its key ID changes,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews increasing by 128, and wrapping around at 65535. So, for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews example, the key "<code class="filename">Kexample.com.+005+10000</code>" becomes
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<code class="filename">Kexample.com.+005+10128</code>".</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>If two keys have ID's exactly 128 apart, and one is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews revoked, then the two key ID's will collide, causing several
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews problems. To prevent this,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keygen</strong></span> will not generate a new key if
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews another key is present which may collide. This checking will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews only occur if the new keys are written to the same directory
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews which holds all other keys in use for that zone.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>Older versions of BIND 9 did not have this precaution.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Exercise caution if using key revocation on keys that were
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews generated by previous releases, or if using keys stored in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews multiple directories or on multiple machines.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>It is expected that a future release of BIND 9 will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews address this problem in a different way, by storing revoked
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews keys with their original unrevoked key ID's.</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="pkcs11"></a>PKCS#11 (Cryptoki) support</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PKCS#11 (Public Key Cryptography Standard #11) defines a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews platform-independent API for the control of hardware security
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews modules (HSMs) and other cryptographic support devices.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews BIND 9 is known to work with three HSMs: The AEP Keyper, which has
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews been tested with Debian Linux, Solaris x86 and Windows Server 2003;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the Thales nShield, tested with Debian Linux; and the Sun SCA 6000
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cryptographic acceleration board, tested with Solaris x86. In
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews addition, BIND can be used with SoftHSM, a software-based HSM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews simulator produced by the OpenDNSSEC project.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PKCS#11 makes use of a "provider library": a dynamically loadable
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews library which provides a low-level PKCS#11 interface to drive the HSM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews hardware. The PKCS#11 provider library comes from the HSM vendor, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews it is specific to the HSM to be controlled.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews There are two available mechanisms for PKCS#11 support in BIND 9:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL-based PKCS#11 and native PKCS#11. When using the first
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews mechanism, BIND uses a modified version of OpenSSL, which loads
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the provider library and operates the HSM indirectly; any
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cryptographic operations not supported by the HSM can be carried
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews out by OpenSSL instead. The second mechanism enables BIND to bypass
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL completely; BIND loads the provider library itself, and uses
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the PKCS#11 API to drive the HSM directly.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2666563"></a>Prerequisites</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews See the documentation provided by your HSM vendor for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews information about installing, initializing, testing and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews troubleshooting the HSM.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2580010"></a>Native PKCS#11</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Native PKCS#11 mode will only work with an HSM capable of carrying
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews out <span class="emphasis"><em>every</em></span> cryptographic operation BIND 9 may
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews need. The HSM's provider library must have a complete implementation
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews of the PKCS#11 API, so that all these functions are accessible. As of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this writing, only the Thales nShield HSM and the latest development
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews version of SoftHSM can be used in this fashion. For other HSM's,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews including the AEP Keyper, Sun SCA 6000 and older versions of SoftHSM,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews use OpenSSL-based PKCS#11. (Note: As more HSMs become capable of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews supporting native PKCS#11, it is expected that OpenSSL-based
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PKCS#11 will eventually be deprecated.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To build BIND with native PKCS#11, configure as follows:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd bind9</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/configure --enable-native-pkcs11 \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --with-pkcs11=<em class="replaceable"><code>provider-library-path</code></em></code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This will cause all BIND tools, including <span><strong class="command">named</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and the <span><strong class="command">dnssec-*</strong></span> and <span><strong class="command">pkcs11-*</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews tools, to use the PKCS#11 provider library specified in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <em class="replaceable"><code>provider-library-path</code></em> for cryptography.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (The provider library path can be overridden using the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="option">-E</code> in <span><strong class="command">named</strong></span> and the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-*</strong></span> tools, or the <code class="option">-m</code> in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the <span><strong class="command">pkcs11-*</strong></span> tools.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2611357"></a>OpenSSL-based PKCS#11</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL-based PKCS#11 mode uses a modified version of the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL library; stock OpenSSL does not fully support PKCS#11.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews ISC provides a patch to OpenSSL to correct this. This patch is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews based on work originally done by the OpenSolaris project; it has been
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews modified by ISC to provide new features such as PIN management and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews key-by-reference.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews There are two "flavors" of PKCS#11 support provided by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the patched OpenSSL, one of which must be chosen at
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configuration time. The correct choice depends on the HSM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Use 'crypto-accelerator' with HSMs that have hardware
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cryptographic acceleration features, such as the SCA 6000
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews board. This causes OpenSSL to run all supported
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews cryptographic operations in the HSM.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Use 'sign-only' with HSMs that are designed to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews function primarily as secure key storage devices, but lack
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews hardware acceleration. These devices are highly secure, but
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are not necessarily any faster at cryptography than the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews system CPU — often, they are slower. It is therefore
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews most efficient to use them only for those cryptographic
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews functions that require access to the secured private key,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews such as zone signing, and to use the system CPU for all
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews other computationally-intensive operations. The AEP Keyper
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is an example of such a device.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The modified OpenSSL code is included in the BIND 9 release,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews in the form of a context diff against the latest versions of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL. OpenSSL 0.9.8, 1.0.0, and 1.0.1 are supported; there are
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews separate diffs for each version. In the examples to follow,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews we use OpenSSL 0.9.8, but the same methods work with OpenSSL
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 1.0.0 and 1.0.1.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The latest OpenSSL versions as of this writing (January 2014)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are 0.9.8y, 1.0.0l, and 1.0.1f.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews ISC will provide updated patches as new versions of OpenSSL
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are released. The version number in the following examples
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews is expected to change.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Before building BIND 9 with PKCS#11 support, it will be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews necessary to build OpenSSL with the patch in place, and configure
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews it with the path to your HSM's PKCS#11 provider library.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2611395"></a>Patching OpenSSL</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>wget <a href="" target="_top">http://www.openssl.org/source/openssl-0.9.8y.tar.gz</a></code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>tar zxf openssl-0.9.8y.tar.gz</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>patch -p1 -d openssl-0.9.8y \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews < bind9/bin/pkcs11/openssl-0.9.8y-patch</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Note that the patch file may not be compatible with the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "patch" utility on all operating systems. You may need to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews install GNU patch.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When building OpenSSL, place it in a non-standard
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews location so that it does not interfere with OpenSSL libraries
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews elsewhere on the system. In the following examples, we choose
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to install into "/opt/pkcs11/usr". We will use this location
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews when we configure BIND 9.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Later, when building BIND 9, the location of the custom-built
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL library will need to be specified via configure.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612068"></a>Building OpenSSL for the AEP Keyper on Linux</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The AEP Keyper is a highly secure key storage device,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews but does not provide hardware cryptographic acceleration. It
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews can carry out cryptographic operations, but it is probably
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews slower than your system's CPU. Therefore, we choose the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 'sign-only' flavor when building OpenSSL.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The Keyper-specific PKCS#11 provider library is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews delivered with the Keyper software. In this example, we place
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cp pkcs11.GCC4.0.2.so.4.05 /opt/pkcs11/usr/lib/libpkcs11.so</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This library is only available for Linux as a 32-bit
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews binary. If we are compiling on a 64-bit Linux system, it is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews necessary to force a 32-bit build, by specifying -m32 in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews build options.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Finally, the Keyper library requires threads, so we
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews must specify -pthread.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd openssl-0.9.8y</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/Configure linux-generic32 -m32 -pthread \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --pk11-libname=/opt/pkcs11/usr/lib/libpkcs11.so \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --pk11-flavor=sign-only \
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt After configuring, run "<span><strong class="command">make</strong></span>"
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt and "<span><strong class="command">make test</strong></span>". If "<span><strong class="command">make
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt test</strong></span>" fails with "pthread_atfork() not found", you forgot to
12bf5d4796505b4c20680531da96a31e6c2c1144Evan Hunt add the -pthread above.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612138"></a>Building OpenSSL for the SCA 6000 on Solaris</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The SCA-6000 PKCS#11 provider is installed as a system
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews library, libpkcs11. It is a true crypto accelerator, up to 4
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews times faster than any CPU, so the flavor shall be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 'crypto-accelerator'.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In this example, we are building on Solaris x86 on an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews AMD64 system.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd openssl-0.9.8y</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/Configure solaris64-x86_64-cc \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --pk11-flavor=crypto-accelerator \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (For a 32-bit build, use "solaris-x86-cc" and /usr/lib/libpkcs11.so.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews After configuring, run
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">make</strong></span> and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">make test</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612257"></a>Building OpenSSL for SoftHSM</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews SoftHSM is a software library provided by the OpenDNSSEC
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews project (http://www.opendnssec.org) which provides a PKCS#11
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews interface to a virtual HSM, implemented in the form of encrypted
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews data on the local filesystem. SoftHSM can be configured to use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews either OpenSSL or the Botan library for encryption, and SQLite3
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for data storage. Though less secure than a true HSM, it can
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews provide more secure key storage than traditional key files,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and can allow you to experiment with PKCS#11 when an HSM is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews not available.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The SoftHSM cryptographic store must be installed and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews initialized before using it with OpenSSL, and the SOFTHSM_CONF
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews environment variable must always point to the SoftHSM configuration
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> cd softhsm-1.3.0 </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> configure --prefix=/opt/pkcs11/usr </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> make </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> make install </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> export SOFTHSM_CONF=/opt/pkcs11/softhsm.conf </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> echo "0:/opt/pkcs11/softhsm.db" > $SOFTHSM_CONF </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code> /opt/pkcs11/usr/bin/softhsm --init-token 0 --slot 0 --label softhsm </code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews SoftHSM can perform all cryptographic operations, but
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews since it only uses your system CPU, there is no advantage to using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews it for anything but signing. Therefore, we choose the 'sign-only'
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews flavor when building OpenSSL.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd openssl-0.9.8y</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/Configure linux-x86_64 -pthread \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --pk11-libname=/opt/pkcs11/usr/lib/libsofthsm.so \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --pk11-flavor=sign-only \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews After configuring, run "<span><strong class="command">make</strong></span>"
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and "<span><strong class="command">make test</strong></span>".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Once you have built OpenSSL, run
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">apps/openssl engine pkcs11</strong></span>" to confirm
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews that PKCS#11 support was compiled in correctly. The output
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews should be one of the following lines, depending on the flavor
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (pkcs11) PKCS #11 engine support (sign only)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (pkcs11) PKCS #11 engine support (crypto accelerator)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">apps/openssl engine pkcs11 -t</strong></span>". This will
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews attempt to initialize the PKCS#11 engine. If it is able to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews do so successfully, it will report
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews “<span class="quote"><code class="literal">[ available ]</code></span>”.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If the output is correct, run
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">make install</strong></span>" which will install the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews modified OpenSSL suite to <code class="filename">/opt/pkcs11/usr</code>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2612408"></a>Configuring BIND 9 for Linux with the AEP Keyper</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To link with the PKCS#11 provider, threads must be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews enabled in the BIND 9 build.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The PKCS#11 library for the AEP Keyper is currently
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews only available as a 32-bit binary. If we are building on a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 64-bit host, we must force a 32-bit build by adding "-m32" to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the CC options on the "configure" command line.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd /bind9</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/configure CC="gcc -m32" --enable-threads \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.so</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2638928"></a>Configuring BIND 9 for Solaris with the SCA 6000</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews To link with the PKCS#11 provider, threads must be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews enabled in the BIND 9 build.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd /bind9</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/configure CC="cc -xarch=amd64" --enable-threads \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --with-pkcs11=/usr/lib/64/libpkcs11.so</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p>(For a 32-bit build, omit CC="cc -xarch=amd64".)</p>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If configure complains about OpenSSL not working, you
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews may have a 32/64-bit architecture mismatch. Or, you may have
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews incorrectly specified the path to OpenSSL (it should be the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews same as the --prefix argument to the OpenSSL
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h4 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2638964"></a>Configuring BIND 9 for SoftHSM</h4></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>cd /bind9</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>/configure --enable-threads \
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --with-pkcs11=/opt/pkcs11/usr/lib/libsofthsm.so</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews After configuring, run
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">make</strong></span>",
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">make test</strong></span>" and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "<span><strong class="command">make install</strong></span>".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (Note: If "make test" fails in the "pkcs11" system test, you may
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews have forgotten to set the SOFTHSM_CONF environment variable.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2639013"></a>PKCS#11 Tools</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews BIND 9 includes a minimal set of tools to operate the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews HSM, including
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-keygen</strong></span> to generate a new key pair
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews within the HSM,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-list</strong></span> to list objects currently
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-destroy</strong></span> to remove objects, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-tokens</strong></span> to list available tokens.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In UNIX/Linux builds, these tools are built only if BIND
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 9 is configured with the --with-pkcs11 option. (Note: If
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews --with-pkcs11 is set to "yes", rather than to the path of the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PKCS#11 provider, then the tools will be built but the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews provider will be left undefined. Use the -m option or the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PKCS11_PROVIDER environment variable to specify the path to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2639049"></a>Using the HSM</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For OpenSSL-based PKCS#11, we must first set up the runtime
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews environment so the OpenSSL and PKCS#11 libraries can be loaded:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>export LD_LIBRARY_PATH=/opt/pkcs11/usr/lib:${LD_LIBRARY_PATH}</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This causes <span><strong class="command">named</strong></span> and other binaries to load
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the OpenSSL library from <code class="filename">/opt/pkcs11/usr/lib</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews rather than from the default location. This step is not necessary
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews when using native PKCS#11.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Some HSMs require other environment variables to be set.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For example, when operating an AEP Keyper, it is necessary to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews specify the location of the "machine" file, which stores
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews information about the Keyper for use by the provider
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews library. If the machine file is in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">/opt/Keyper/PKCS11Provider/machine</code>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>export KEYPER_LIBRARY_PATH=/opt/Keyper/PKCS11Provider</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Such environment variables must be set whenever running
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews any tool that uses the HSM, including
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-keygen</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-list</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">pkcs11-destroy</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keyfromlabel</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-signzone</strong></span>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-keygen</strong></span>, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">named</strong></span>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews We can now create and use keys in the HSM. In this case,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews we will create a 2048 bit key and give it the label
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "sample-ksk":
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>pkcs11-keygen -b 2048 -l sample-ksk</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>pkcs11-list</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsobject[0]: handle 2147483658 class 3 label[8] 'sample-ksk' id[0]
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewsobject[1]: handle 2147483657 class 2 label[8] 'sample-ksk' id[0]
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Before using this key to sign a zone, we must create a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews pair of BIND 9 key files. The "dnssec-keyfromlabel" utility
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews does this. In this case, we will be using the HSM key
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "sample-ksk" as the key-signing key for "example.net":
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-keyfromlabel -l sample-ksk -f KSK example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The resulting K*.key and K*.private files can now be used
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to sign the zone. Unlike normal K* files, which contain both
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews public and private key data, these files will contain only the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews public key data, plus an identifier for the private key which
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews remains stored within the HSM. Signing with the private key takes
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews place inside the HSM.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If you wish to generate a second key in the HSM for use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews as a zone-signing key, follow the same procedure above, using a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews different keylabel, a smaller key size, and omitting "-f KSK"
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews from the dnssec-keyfromlabel arguments:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (Note: When using OpenSSL-based PKCS#11 the label is an arbitrary
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews string which identifies the key. With native PKCS#11, the label is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a PKCS#11 URI string which may include other details about the key
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and the HSM, including its PIN. See
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <a href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel"><span class="refentrytitle"><span class="application">dnssec-keyfromlabel</span></span>(8)</a> for details.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>pkcs11-keygen -b 1024 -l sample-zsk</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-keyfromlabel -l sample-zsk example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Alternatively, you may prefer to generate a conventional
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews on-disk key, using dnssec-keygen:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-keygen example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This provides less security than an HSM key, but since
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews HSMs can be slow or cumbersome to use for security reasons, it
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews may be more efficient to reserve HSM keys for use in the less
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews frequent key-signing operation. The zone-signing key can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews rolled more frequently, if you wish, to compensate for a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews reduction in key security. (Note: When using native PKCS#11,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews there is no speed advantage to using on-disk keys, as cryptographic
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews operations will be done by the HSM regardless.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Now you can sign the zone. (Note: If not using the -S
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews option to <span><strong class="command">dnssec-signzone</strong></span>, it will be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews necessary to add the contents of both <code class="filename">K*.key</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews files to the zone master file before signing it.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-signzone -S example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark AndrewsVerifying the zone using the following algorithms:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark AndrewsNSEC3RSASHA1.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark AndrewsZone signing complete:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark AndrewsAlgorithm: NSEC3RSASHA1: ZSKs: 1, KSKs: 1 active, 0 revoked, 0 stand-by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2639403"></a>Specifying the engine on the command line</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When using OpenSSL-based PKCS#11, the "engine" to be used by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews OpenSSL can be specified in <span><strong class="command">named</strong></span> and all of
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the BIND <span><strong class="command">dnssec-*</strong></span> tools by using the "-E
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <engine>" command line option. If BIND 9 is built with
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the --with-pkcs11 option, this option defaults to "pkcs11".
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Specifying the engine will generally not be necessary unless
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for some reason you wish to use a different OpenSSL
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If you wish to disable use of the "pkcs11" engine —
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for troubleshooting purposes, or because the HSM is unavailable
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews — set the engine to the empty string. For example:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ <strong class="userinput"><code>dnssec-signzone -E '' -S example.net</code></strong>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dnssec-signzone</strong></span> to run as if it were compiled
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews without the --with-pkcs11 option.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When built with native PKCS#11 mode, the "engine" option has a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews different meaning: it specifies the path to the PKCS#11 provider
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews library. This may be useful when testing a new provider library.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2639451"></a>Running named with automatic zone re-signing</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If you want <span><strong class="command">named</strong></span> to dynamically re-sign zones
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews using HSM keys, and/or to to sign new records inserted via nsupdate,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews then named must have access to the HSM PIN. In OpenSSL-based PKCS#11,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this is accomplished by placing the PIN into the openssl.cnf file
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews (in the above examples,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">/opt/pkcs11/usr/ssl/openssl.cnf</code>).
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The location of the openssl.cnf file can be overridden by
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews setting the OPENSSL_CONF environment variable before running
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews openssl_conf = openssl_def
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews [ openssl_def ]
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews engines = engine_section
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews [ engine_section ]
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews pkcs11 = pkcs11_section
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews [ pkcs11_section ]
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews PIN = <em class="replaceable"><code><PLACE PIN HERE></code></em>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This will also allow the dnssec-* tools to access the HSM
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews without PIN entry. (The pkcs11-* tools access the HSM directly,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews not via OpenSSL, so a PIN will still be required to use
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In native PKCS#11 mode, the PIN can be provided in a file specified
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews as an attribute of the key's label. For example, if a key had the label
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <strong class="userinput"><code>pkcs11:object=local-zsk;pin-source=/etc/hsmpin"</code></strong>,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews then the PIN would be read from the file
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Placing the HSM's PIN in a text file in this manner may reduce the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews security advantage of using an HSM. Be sure this is what you want to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews do before configuring the system in this way.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
bce9696c7ac65792469b29ce0ad13564953b62caEvan Hunt<a name="dlz-info"></a>DLZ (Dynamically Loadable Zones)</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DLZ (Dynamically Loadable Zones) is an extension to BIND 9 that allows
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone data to be retrieved directly from an external database. There is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews no required format or schema. DLZ drivers exist for several different
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews database backends including PostgreSQL, MySQL, and LDAP and can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews written for any other.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Historically, DLZ drivers had to be statically linked with the named
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews binary and were turned on via a configure option at compile time (for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews example, <strong class="userinput"><code>"configure --with-dlz-ldap"</code></strong>).
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt Currently, the drivers provided in the BIND 9 tarball in
98091cb21da79b0c7fd329fd64497dcb03402467Evan Hunt <code class="filename">contrib/dlz/drivers</code> are still linked this
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In BIND 9.8 and higher, it is possible to link some DLZ modules
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dynamically at runtime, via the DLZ "dlopen" driver, which acts as a
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews generic wrapper around a shared object implementing the DLZ API. The
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "dlopen" driver is linked into named by default, so configure options
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews are no longer necessary when using these dynamically linkable drivers,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews but are still needed for the older drivers in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">contrib/dlz/drivers</code>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When the DLZ module provides data to named, it does so in text format.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The response is converted to DNS wire format by named. This
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews conversion, and the lack of any internal caching, places significant
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews limits on the query performance of DLZ modules. Consequently, DLZ is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews not recommended for use on high-volume servers. However, it can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews used in a hidden master configuration, with slaves retrieving zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews updates via AXFR. (Note, however, that DLZ has no built-in support for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews DNS notify; slaves are not automatically informed of changes to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zones in the database.)
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2639515"></a>Configuring DLZ</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews A DLZ database is configured with a <span><strong class="command">dlz</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews statement in <code class="filename">named.conf</code>:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dlz example {
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews database "dlopen driver.so <code class="option">args</code>";
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews This specifies a DLZ module to search when answering queries; the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews module is implemented in <code class="filename">driver.so</code> and is
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews loaded at runtime by the dlopen DLZ driver. Multiple
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span><strong class="command">dlz</strong></span> statements can be specified; when
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews answering a query, all DLZ modules with <code class="option">search</code>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews set to <code class="literal">yes</code> will be queried to find out if
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews they contain an answer for the query name; the best available
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews answer will be returned to the client.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The <code class="option">search</code> option in the above example can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews omitted, because <code class="literal">yes</code> is the default value.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If <code class="option">search</code> is set to <code class="literal">no</code>, then
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this DLZ module is <span class="emphasis"><em>not</em></span> searched for the best
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews match when a query is received. Instead, zones in this DLZ must be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews separately specified in a zone statement. This allows you to
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews configure a zone normally using standard zone option semantics,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews but specify a different database back-end for storage of the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews zone's data. For example, to implement NXDOMAIN redirection using
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a DLZ module for back-end storage of redirection rules:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews database "dlopen driver.so <code class="option">args</code>";
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews type redirect;
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2611668"></a>Sample DLZ Driver</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For guidance in implementation of DLZ modules, the directory
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">contrib/dlz/example</code> contains a basic
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews dynamically-linkable DLZ module--i.e., one which can be
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews loaded at runtime by the "dlopen" DLZ driver.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The example sets up a single zone, whose name is passed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews to the module as an argument in the <span><strong class="command">dlz</strong></span>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In the above example, the module is configured to create a zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews "example.nil", which can answer queries and AXFR requests, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews accept DDNS updates. At runtime, prior to any updates, the zone
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews contains an SOA, NS, and a single A record at the apex:
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews example.nil. 3600 IN SOA example.nil. hostmaster.example.nil. (
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews 123 900 600 86400 3600
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews example.nil. 1800 IN A 10.53.0.1
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The sample driver is capable of retrieving information about the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews querying client, and altering its response on the basis of this
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews information. To demonstrate this feature, the example driver
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews responds to queries for "source-addr.<code class="option">zonename</code>>/TXT"
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews with the source address of the query. Note, however, that this
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews record will *not* be included in AXFR or ANY responses. Normally,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews this feature would be used to alter responses in some other fashion,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews e.g., by providing different address records for a particular name
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews depending on the network from which the query arrived.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Documentation of the DLZ module API can be found in
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="filename">contrib/dlz/example/README</code>. This directory also
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews contains the header file <code class="filename">dlz_minimal.h</code>, which
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews defines the API and should be included by any dynamically-linkable
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h2 class="title" style="clear: both">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2571588"></a>IPv6 Support in <acronym class="acronym">BIND</acronym> 9</h2></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <acronym class="acronym">BIND</acronym> 9 fully supports all currently
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews defined forms of IPv6 name to address and address to name
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews lookups. It will also use IPv6 addresses to make queries when
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews running on an IPv6 capable system.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For forward lookups, <acronym class="acronym">BIND</acronym> 9 supports
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews only AAAA records. RFC 3363 deprecated the use of A6 records,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and client-side support for A6 records was accordingly removed
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews from <acronym class="acronym">BIND</acronym> 9.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews However, authoritative <acronym class="acronym">BIND</acronym> 9 name servers still
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews load zone files containing A6 records correctly, answer queries
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews for A6 records, and accept zone transfer for a zone containing A6
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For IPv6 reverse lookups, <acronym class="acronym">BIND</acronym> 9 supports
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the traditional "nibble" format used in the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="emphasis"><em>ip6.arpa</em></span> domain, as well as the older, deprecated
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <span class="emphasis"><em>ip6.int</em></span> domain.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Older versions of <acronym class="acronym">BIND</acronym> 9
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt supported the "binary label" (also known as "bitstring") format,
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt but support of binary labels has been completely removed per
dbb012765c735ee0d82dedb116cdc7cf18957814Evan Hunt Many applications in <acronym class="acronym">BIND</acronym> 9 do not understand
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the binary label format at all any more, and will return an
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews error if given.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews In particular, an authoritative <acronym class="acronym">BIND</acronym> 9
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews name server will not load a zone file containing binary labels.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For an overview of the format and structure of IPv6 addresses,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews see <a href="Bv9ARM.ch09.html#ipv6addresses" title="IPv6 addresses (AAAA)">the section called “IPv6 addresses (AAAA)”</a>.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2571854"></a>Address Lookups Using AAAA Records</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews The IPv6 AAAA record is a parallel to the IPv4 A record,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews and, unlike the deprecated A6 record, specifies the entire
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews IPv6 address in a single record. For example,
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrewshost 3600 IN AAAA 2001:db8::1
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews Use of IPv4-in-IPv6 mapped addresses is not recommended.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews If a host has an IPv4 address, use an A record, not
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a AAAA, with <code class="literal">::ffff:192.168.42.1</code> as
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews the address.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<div class="titlepage"><div><div><h3 class="title">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a name="id2571876"></a>Address to Name Lookups Using Nibble Format</h3></div></div></div>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews When looking up an address in nibble format, the address
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews components are simply reversed, just as in IPv4, and
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <code class="literal">ip6.arpa.</code> is appended to the
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews resulting name.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews For example, the following would provide reverse name lookup for
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews a host with address
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews$ORIGIN 0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 14400 IN PTR (
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<table width="100%" summary="Navigation footer">
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<a accesskey="p" href="Bv9ARM.ch03.html">Prev</a>�</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="40%" align="right">�<a accesskey="n" href="Bv9ARM.ch05.html">Next</a>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="40%" align="left" valign="top">Chapter�3.�Name Server Configuration�</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<td width="40%" align="right" valign="top">�Chapter�5.�The <acronym class="acronym">BIND</acronym> 9 Lightweight Resolver</td>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews<p style="text-align: center;">BIND Version 9.11</p>