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