dnssec-importkey.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews<!--
28d9fd53819cc163629c867466b20d8ebcae8842David Lawrence - Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence-->
15a44745412679c30a6d022733925af70a38b715David Lawrence<html>
15a44745412679c30a6d022733925af70a38b715David Lawrence<head>
15a44745412679c30a6d022733925af70a38b715David Lawrence<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
15a44745412679c30a6d022733925af70a38b715David Lawrence<title>dnssec-importkey</title>
15a44745412679c30a6d022733925af70a38b715David Lawrence<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
15a44745412679c30a6d022733925af70a38b715David Lawrence</head>
15a44745412679c30a6d022733925af70a38b715David Lawrence<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
15a44745412679c30a6d022733925af70a38b715David Lawrence<a name="man.dnssec-importkey"></a><div class="titlepage"></div>
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews<div class="refnamediv">
5d51e67c3b4f35c1be742574aacc1d88fe6ed444Mark Andrews<h2>Name</h2>
4be63b1fd8c18dbeca1648d6cf22fa14f057a469David Lawrence<p><span class="application">dnssec-importkey</span> &#8212; import DNSKEY records from external systems so they can be managed</p>
4be63b1fd8c18dbeca1648d6cf22fa14f057a469David Lawrence</div>
4be63b1fd8c18dbeca1648d6cf22fa14f057a469David Lawrence<div class="refsynopsisdiv">
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<h2>Synopsis</h2>
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews<div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] {<code class="option">keyfile</code>}</p></div>
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews<div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>} [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">dnsname</code>]</p></div>
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews</div>
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews<div class="refsection">
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews<a name="id-1.7"></a><h2>DESCRIPTION</h2>
b186f1ab91faf6d46d102ecbfd55cbdb7e24feeeMark Andrews<p><span class="command"><strong>dnssec-importkey</strong></span>
3761c433912beabe43abeed2c3513b6201c59f64Mark Andrews reads a public DNSKEY record and generates a pair of
4be63b1fd8c18dbeca1648d6cf22fa14f057a469David Lawrence .key/.private files. The DNSKEY record may be read from an
4be63b1fd8c18dbeca1648d6cf22fa14f057a469David Lawrence existing .key file, in which case a corresponding .private file
will be generated, or it may be read from any other file or
from the standard input, in which case both .key and .private
files will be generated.
</p>
<p>
The newly-created .private file does <span class="emphasis"><em>not</em></span>
contain private key data, and cannot be used for signing.
However, having a .private file makes it possible to set
publication (<code class="option">-P</code>) and deletion
(<code class="option">-D</code>) times for the key, which means the
public key can be added to and removed from the DNSKEY RRset
on schedule even if the true private key is stored offline.
</p>
</div>
<div class="refsection">
<a name="id-1.8"></a><h2>OPTIONS</h2>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
<dd>
<p>
Zone file mode: instead of a public keyfile name, the argument
is the DNS domain name of a zone master file, which can be read
from <code class="option">file</code>. If the domain name is the same as
<code class="option">file</code>, then it may be omitted.
</p>
<p>
If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
the zone data is read from the standard input.
</p>
</dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd><p>
Sets the directory in which the key files are to reside.
</p></dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
<dd><p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
already a DNSKEY RRset in place, in which case the existing TTL
would take precedence. Setting the default TTL to
<code class="literal">0</code> or <code class="literal">none</code> removes it.
</p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
Emit usage message and exit.
</p></dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
<dd><p>
Sets the debugging level.
</p></dd>
<dt><span class="term">-V</span></dt>
<dd><p>
Prints version information.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.9"></a><h2>TIMING OPTIONS</h2>
<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
then the offset is computed in years (defined as 365 24-hour days,
ignoring leap years), months (defined as 30 24-hour days), weeks,
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</p>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it.
</p></dd>
<dt><span class="term">-P sync <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which CDS and CDNSKEY records that match this
key are to be published to the zone.
</p></dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
</p></dd>
<dt><span class="term">-D sync <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the CDS and CDNSKEY records that match
this key are to be deleted.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.10"></a><h2>FILES</h2>
<p>
A keyfile can be designed by the key identification
<code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
<code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
<span class="refentrytitle">dnssec-keygen</span>(8).
</p>
</div>
<div class="refsection">
<a name="id-1.11"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5011</em>.
</p>
</div>
</div></body>
</html>