1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3               [<!ENTITY mdash "&#8212;">]>
4<!--
5 - Copyright (C) 2013  Internet Systems Consortium, Inc. ("ISC")
6 -
7 - Permission to use, copy, modify, and/or distribute this software for any
8 - purpose with or without fee is hereby granted, provided that the above
9 - copyright notice and this permission notice appear in all copies.
10 -
11 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 - PERFORMANCE OF THIS SOFTWARE.
18-->
19
20<!-- $Id: dnssec-importkey.docbook,v 1.15 2011/11/03 20:21:37 each Exp $ -->
21<refentry id="man.dnssec-importkey">
22  <refentryinfo>
23    <date>August 30, 2013</date>
24  </refentryinfo>
25
26  <refmeta>
27    <refentrytitle><application>dnssec-importkey</application></refentrytitle>
28    <manvolnum>8</manvolnum>
29    <refmiscinfo>BIND9</refmiscinfo>
30  </refmeta>
31
32  <refnamediv>
33    <refname><application>dnssec-importkey</application></refname>
34    <refpurpose>Import DNSKEY records from external systems so they can be managed.</refpurpose>
35  </refnamediv>
36
37  <docinfo>
38    <copyright>
39      <year>2013</year>
40      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
41    </copyright>
42  </docinfo>
43
44  <refsynopsisdiv>
45    <cmdsynopsis>
46      <command>dnssec-importkey</command>
47      <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
48      <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
49      <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
50      <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
51      <arg><option>-h</option></arg>
52      <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
53      <arg choice="req"><option>keyfile</option></arg>
54    </cmdsynopsis>
55    <cmdsynopsis>
56      <command>dnssec-importkey</command>
57      <arg choice="req"><option>-f <replaceable class="parameter">filename</replaceable></option></arg>
58      <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
59      <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
60      <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
61      <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
62      <arg><option>-h</option></arg>
63      <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
64      <arg><option>dnsname</option></arg>
65    </cmdsynopsis>
66  </refsynopsisdiv>
67
68  <refsect1>
69    <title>DESCRIPTION</title>
70    <para><command>dnssec-importkey</command>
71      reads a public DNSKEY record and generates a pair of
72      .key/.private files.  The DNSKEY record may be read from an
73      existing .key file, in which case a corresponding .private file
74      will be generated, or it may be read from any other file or
75      from the standard input, in which case both .key and .private
76      files will be generated.
77    </para>
78    <para>
79      The newly-created .private file does <emphasis>not</command>
80      contain private key data, and cannot be used for signing.
81      However, having a .private file makes it possible to set
82      publication (<option>-P</option>) and deletion
83      (<option>-D</option>) times for the key, which means the
84      public key can be added to and removed from the DNSKEY RRset
85      on schedule even if the true private key is stored offline.
86    </para>
87  </refsect1>
88
89  <refsect1>
90    <title>OPTIONS</title>
91
92    <variablelist>
93      <varlistentry>
94	<term>-f <replaceable class="parameter">filename</replaceable></term>
95        <listitem>
96          <para>
97            Zone file mode: instead of a public keyfile name, the argument
98	    is the DNS domain name of a zone master file, which can be read
99            from <option>file</option>.  If the domain name is the same as
100            <option>file</option>, then it may be omitted.
101          </para>
102          <para>
103            If <option>file</option> is set to <literal>"-"</literal>, then
104            the zone data is read from the standard input.
105          </para>
106        </listitem>
107      </varlistentry>
108  
109      <varlistentry>
110        <term>-K <replaceable class="parameter">directory</replaceable></term>
111        <listitem>
112          <para>
113            Sets the directory in which the key files are to reside.
114          </para>
115        </listitem>
116      </varlistentry>
117
118      <varlistentry>
119        <term>-L <replaceable class="parameter">ttl</replaceable></term>
120        <listitem>
121          <para>
122            Sets the default TTL to use for this key when it is converted
123            into a DNSKEY RR.  If the key is imported into a zone,
124            this is the TTL that will be used for it, unless there was
125            already a DNSKEY RRset in place, in which case the existing TTL
126            would take precedence.  Setting the default TTL to
127            <literal>0</literal> or <literal>none</literal> removes it.
128          </para>
129        </listitem>
130      </varlistentry>
131
132      <varlistentry>
133	<term>-h</term>
134        <listitem>
135	  <para>
136	    Emit usage message and exit.
137	  </para>
138        </listitem>
139      </varlistentry>
140  
141      <varlistentry>
142        <term>-v <replaceable class="parameter">level</replaceable></term>
143        <listitem>
144          <para>
145            Sets the debugging level.
146          </para>
147        </listitem>
148      </varlistentry>
149
150    </variablelist>
151  </refsect1>
152
153  <refsect1>
154    <title>TIMING OPTIONS</title>
155    <para>
156      Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
157      If the argument begins with a '+' or '-', it is interpreted as
158      an offset from the present time.  For convenience, if such an offset
159      is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
160      then the offset is computed in years (defined as 365 24-hour days,
161      ignoring leap years), months (defined as 30 24-hour days), weeks,
162      days, hours, or minutes, respectively.  Without a suffix, the offset
163      is computed in seconds.  To unset a date, use 'none'.
164    </para>
165
166    <variablelist>
167      <varlistentry>
168        <term>-P <replaceable class="parameter">date/offset</replaceable></term>
169        <listitem>
170          <para>
171            Sets the date on which a key is to be published to the zone.
172            After that date, the key will be included in the zone but will
173            not be used to sign it.
174          </para>
175        </listitem>
176      </varlistentry>
177
178      <varlistentry>
179        <term>-D <replaceable class="parameter">date/offset</replaceable></term>
180        <listitem>
181          <para>
182            Sets the date on which the key is to be deleted.  After that
183            date, the key will no longer be included in the zone.  (It
184            may remain in the key repository, however.)
185          </para>
186        </listitem>
187      </varlistentry>
188
189    </variablelist>
190  </refsect1>
191
192  <refsect1>
193    <title>FILES</title>
194    <para>
195      A keyfile can be designed by the key identification
196      <filename>Knnnn.+aaa+iiiii</filename> or the full file name
197      <filename>Knnnn.+aaa+iiiii.key</filename> as generated by
198      <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>.
199    </para>
200  </refsect1>
201
202  <refsect1>
203    <title>SEE ALSO</title>
204    <para><citerefentry>
205        <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
206      </citerefentry>,
207      <citerefentry>
208        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
209      </citerefentry>,
210      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
211      <citetitle>RFC 5011</citetitle>.
212    </para>
213  </refsect1>
214
215  <refsect1>
216    <title>AUTHOR</title>
217    <para><corpauthor>Internet Systems Consortium</corpauthor>
218    </para>
219  </refsect1>
220
221</refentry><!--
222 - Local variables:
223 - mode: sgml
224 - End:
225-->
226