dnssec-importkey.html revision 010a51c427bfb6ab658fc0056955a1a5b69810be
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<!--
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin - Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC")
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin -
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - Permission to use, copy, modify, and/or distribute this software for any
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin - purpose with or without fee is hereby granted, provided that the above
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - copyright notice and this permission notice appear in all copies.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin -
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin - PERFORMANCE OF THIS SOFTWARE.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin-->
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<html>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<title>dnssec-importkey</title>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="dnssec-importkey">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="man.dnssec-importkey"></a><div class="titlepage"></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refnamediv">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Name</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <span class="application">dnssec-importkey</span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin &#8212; Import DNSKEY records from external systems so they can be managed.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsynopsisdiv" title="Synopsis">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Synopsis</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="cmdsynopsis"><p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="command">dnssec-importkey</code>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-h</code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-V</code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin {<code class="option">keyfile</code>}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="cmdsynopsis"><p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="command">dnssec-importkey</code>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-h</code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">-V</code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<code class="option">dnsname</code>]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsection" title="DESCRIPTION">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="idp60920016"></a><h2>DESCRIPTION</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p><span class="command"><strong>dnssec-importkey</strong></span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin reads a public DNSKEY record and generates a pair of
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin .key/.private files. The DNSKEY record may be read from an
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin existing .key file, in which case a corresponding .private file
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin will be generated, or it may be read from any other file or
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin from the standard input, in which case both .key and .private
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin files will be generated.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin The newly-created .private file does <span class="emphasis"><em>not</em></span>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin contain private key data, and cannot be used for signing.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin However, having a .private file makes it possible to set
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin publication (<code class="option">-P</code>) and deletion
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin (<code class="option">-D</code>) times for the key, which means the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin public key can be added to and removed from the DNSKEY RRset
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin on schedule even if the true private key is stored offline.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsection" title="OPTIONS">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="idp60923216"></a><h2>OPTIONS</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="variablelist"><dl>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Zone file mode: instead of a public keyfile name, the argument
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin is the DNS domain name of a zone master file, which can be read
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin from <code class="option">file</code>. If the domain name is the same as
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="option">file</code>, then it may be omitted.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin the zone data is read from the standard input.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Sets the directory in which the key files are to reside.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Sets the default TTL to use for this key when it is converted
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin into a DNSKEY RR. If the key is imported into a zone,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin this is the TTL that will be used for it, unless there was
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin already a DNSKEY RRset in place, in which case the existing TTL
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin would take precedence. Setting the default TTL to
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="literal">0</code> or <code class="literal">none</code> removes it.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-h</span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Emit usage message and exit.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Sets the debugging level.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-V</span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Prints version information.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</dl></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsection" title="TIMING OPTIONS">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="idp60995664"></a><h2>TIMING OPTIONS</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin If the argument begins with a '+' or '-', it is interpreted as
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin an offset from the present time. For convenience, if such an offset
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin then the offset is computed in years (defined as 365 24-hour days,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin ignoring leap years), months (defined as 30 24-hour days), weeks,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin days, hours, or minutes, respectively. Without a suffix, the offset
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin is computed in seconds. To explicitly prevent a date from being
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin set, use 'none' or 'never'.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="variablelist"><dl>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Sets the date on which a key is to be published to the zone.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin After that date, the key will be included in the zone but will
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin not be used to sign it.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Sets the date on which the key is to be deleted. After that
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin date, the key will no longer be included in the zone. (It
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin may remain in the key repository, however.)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </dd>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</dl></div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsection" title="FILES">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="idp61001424"></a><h2>FILES</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin A keyfile can be designed by the key identification
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <span class="refentrytitle">dnssec-keygen</span>(8).
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <div class="refsection" title="SEE ALSO">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="idp61004240"></a><h2>SEE ALSO</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <p><span class="citerefentry">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <span class="refentrytitle">dnssec-keygen</span>(8)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </span>,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <span class="citerefentry">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <span class="refentrytitle">dnssec-signzone</span>(8)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </span>,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <em class="citetitle">RFC 5011</em>.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div></body>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</html>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin