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