dnssec-importkey.html revision 7911e6f9de303bca5a3d8b34f4330c8f7cecffae
f808c858fa61e7769218966759510a8b1190dfcfraf<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
f808c858fa61e7769218966759510a8b1190dfcfraf<!--
f808c858fa61e7769218966759510a8b1190dfcfraf - Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
f808c858fa61e7769218966759510a8b1190dfcfraf -
f808c858fa61e7769218966759510a8b1190dfcfraf - This Source Code Form is subject to the terms of the Mozilla Public
f808c858fa61e7769218966759510a8b1190dfcfraf - License, v. 2.0. If a copy of the MPL was not distributed with this
f808c858fa61e7769218966759510a8b1190dfcfraf - file, You can obtain one at http://mozilla.org/MPL/2.0/.
f808c858fa61e7769218966759510a8b1190dfcfraf-->
f808c858fa61e7769218966759510a8b1190dfcfraf<html lang="en">
f808c858fa61e7769218966759510a8b1190dfcfraf<head>
f808c858fa61e7769218966759510a8b1190dfcfraf<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f808c858fa61e7769218966759510a8b1190dfcfraf<title>dnssec-importkey</title>
f808c858fa61e7769218966759510a8b1190dfcfraf<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
f808c858fa61e7769218966759510a8b1190dfcfraf</head>
f808c858fa61e7769218966759510a8b1190dfcfraf<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
f808c858fa61e7769218966759510a8b1190dfcfraf<a name="man.dnssec-importkey"></a><div class="titlepage"></div>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami <div class="refnamediv">
f808c858fa61e7769218966759510a8b1190dfcfraf<h2>Name</h2>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami<p>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami <span class="application">dnssec-importkey</span>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami &#8212; import DNSKEY records from external systems so they can be managed
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami </p>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami</div>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami <div class="refsynopsisdiv">
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami<h2>Synopsis</h2>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami <div class="cmdsynopsis"><p>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami <code class="command">dnssec-importkey</code>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>]
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-h</code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-V</code>]
f808c858fa61e7769218966759510a8b1190dfcfraf {<code class="option">keyfile</code>}
f808c858fa61e7769218966759510a8b1190dfcfraf </p></div>
f808c858fa61e7769218966759510a8b1190dfcfraf <div class="cmdsynopsis"><p>
f808c858fa61e7769218966759510a8b1190dfcfraf <code class="command">dnssec-importkey</code>
f808c858fa61e7769218966759510a8b1190dfcfraf {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>}
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-h</code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">-V</code>]
f808c858fa61e7769218966759510a8b1190dfcfraf [<code class="option">dnsname</code>]
f808c858fa61e7769218966759510a8b1190dfcfraf </p></div>
f808c858fa61e7769218966759510a8b1190dfcfraf </div>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <div class="refsection">
f808c858fa61e7769218966759510a8b1190dfcfraf<a name="id-1.7"></a><h2>DESCRIPTION</h2>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <p><span class="command"><strong>dnssec-importkey</strong></span>
f808c858fa61e7769218966759510a8b1190dfcfraf reads a public DNSKEY record and generates a pair of
f808c858fa61e7769218966759510a8b1190dfcfraf .key/.private files. The DNSKEY record may be read from an
f808c858fa61e7769218966759510a8b1190dfcfraf existing .key file, in which case a corresponding .private file
f808c858fa61e7769218966759510a8b1190dfcfraf will be generated, or it may be read from any other file or
f808c858fa61e7769218966759510a8b1190dfcfraf from the standard input, in which case both .key and .private
f808c858fa61e7769218966759510a8b1190dfcfraf files will be generated.
f808c858fa61e7769218966759510a8b1190dfcfraf </p>
f808c858fa61e7769218966759510a8b1190dfcfraf <p>
f808c858fa61e7769218966759510a8b1190dfcfraf The newly-created .private file does <span class="emphasis"><em>not</em></span>
f808c858fa61e7769218966759510a8b1190dfcfraf contain private key data, and cannot be used for signing.
f808c858fa61e7769218966759510a8b1190dfcfraf However, having a .private file makes it possible to set
f808c858fa61e7769218966759510a8b1190dfcfraf publication (<code class="option">-P</code>) and deletion
f808c858fa61e7769218966759510a8b1190dfcfraf (<code class="option">-D</code>) times for the key, which means the
f808c858fa61e7769218966759510a8b1190dfcfraf public key can be added to and removed from the DNSKEY RRset
f808c858fa61e7769218966759510a8b1190dfcfraf on schedule even if the true private key is stored offline.
f808c858fa61e7769218966759510a8b1190dfcfraf </p>
f808c858fa61e7769218966759510a8b1190dfcfraf </div>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <div class="refsection">
f808c858fa61e7769218966759510a8b1190dfcfraf<a name="id-1.8"></a><h2>OPTIONS</h2>
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf
f808c858fa61e7769218966759510a8b1190dfcfraf <div class="variablelist"><dl class="variablelist">
f808c858fa61e7769218966759510a8b1190dfcfraf<dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
f808c858fa61e7769218966759510a8b1190dfcfraf<dd>
f808c858fa61e7769218966759510a8b1190dfcfraf <p>
f808c858fa61e7769218966759510a8b1190dfcfraf 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>