dnssec-importkey.docbook revision 1753d3c4d74241a847794f7e7cfd94cc79be6600
2N/A<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
2N/A [<!ENTITY mdash "&#8212;">]>
2N/A<!--
2N/A - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
2N/A -
2N/A - Permission to use, copy, modify, and/or distribute this software for any
2N/A - purpose with or without fee is hereby granted, provided that the above
2N/A - copyright notice and this permission notice appear in all copies.
2N/A -
2N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2N/A - PERFORMANCE OF THIS SOFTWARE.
2N/A-->
2N/A
2N/A<refentry id="man.dnssec-importkey">
2N/A <refentryinfo>
2N/A <date>February 20, 2014</date>
2N/A </refentryinfo>
2N/A
2N/A <refmeta>
2N/A <refentrytitle><application>dnssec-importkey</application></refentrytitle>
2N/A <manvolnum>8</manvolnum>
2N/A <refmiscinfo>BIND9</refmiscinfo>
2N/A </refmeta>
2N/A
2N/A <refnamediv>
2N/A <refname><application>dnssec-importkey</application></refname>
2N/A <refpurpose>Import DNSKEY records from external systems so they can be managed.</refpurpose>
2N/A </refnamediv>
2N/A
2N/A <docinfo>
2N/A <copyright>
2N/A <year>2013</year>
2N/A <year>2014</year>
2N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
2N/A </copyright>
2N/A </docinfo>
2N/A
2N/A <refsynopsisdiv>
2N/A <cmdsynopsis>
2N/A <command>dnssec-importkey</command>
2N/A <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
2N/A <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
2N/A <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
2N/A <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
2N/A <arg><option>-h</option></arg>
2N/A <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
2N/A <arg choice="req"><option>keyfile</option></arg>
2N/A </cmdsynopsis>
2N/A <cmdsynopsis>
2N/A <command>dnssec-importkey</command>
2N/A <arg choice="req"><option>-f <replaceable class="parameter">filename</replaceable></option></arg>
2N/A <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
2N/A <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
2N/A <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
2N/A <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
2N/A <arg><option>-h</option></arg>
2N/A <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
2N/A <arg><option>dnsname</option></arg>
2N/A </cmdsynopsis>
2N/A </refsynopsisdiv>
2N/A
2N/A <refsect1>
2N/A <title>DESCRIPTION</title>
2N/A <para><command>dnssec-importkey</command>
2N/A reads a public DNSKEY record and generates a pair of
2N/A .key/.private files. The DNSKEY record may be read from an
2N/A existing .key file, in which case a corresponding .private file
2N/A will be generated, or it may be read from any other file or
2N/A from the standard input, in which case both .key and .private
2N/A files will be generated.
2N/A </para>
2N/A <para>
2N/A The newly-created .private file does <emphasis>not</emphasis>
2N/A contain private key data, and cannot be used for signing.
2N/A However, having a .private file makes it possible to set
2N/A publication (<option>-P</option>) and deletion
2N/A (<option>-D</option>) times for the key, which means the
2N/A public key can be added to and removed from the DNSKEY RRset
2N/A on schedule even if the true private key is stored offline.
2N/A </para>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>OPTIONS</title>
2N/A
2N/A <variablelist>
2N/A <varlistentry>
2N/A <term>-f <replaceable class="parameter">filename</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Zone file mode: instead of a public keyfile name, the argument
2N/A is the DNS domain name of a zone master file, which can be read
2N/A from <option>file</option>. If the domain name is the same as
2N/A <option>file</option>, then it may be omitted.
2N/A </para>
2N/A <para>
2N/A If <option>file</option> is set to <literal>"-"</literal>, then
2N/A the zone data is read from the standard input.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A <varlistentry>
2N/A <term>-K <replaceable class="parameter">directory</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Sets the directory in which the key files are to reside.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A <varlistentry>
2N/A <term>-L <replaceable class="parameter">ttl</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Sets the default TTL to use for this key when it is converted
2N/A into a DNSKEY RR. If the key is imported into a zone,
2N/A this is the TTL that will be used for it, unless there was
2N/A already a DNSKEY RRset in place, in which case the existing TTL
2N/A would take precedence. Setting the default TTL to
2N/A <literal>0</literal> or <literal>none</literal> removes it.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A <varlistentry>
2N/A <term>-h</term>
2N/A <listitem>
2N/A <para>
2N/A Emit usage message and exit.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A <varlistentry>
2N/A <term>-v <replaceable class="parameter">level</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Sets the debugging level.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A </variablelist>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>TIMING OPTIONS</title>
2N/A <para>
2N/A Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
2N/A If the argument begins with a '+' or '-', it is interpreted as
2N/A an offset from the present time. For convenience, if such an offset
2N/A is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
2N/A then the offset is computed in years (defined as 365 24-hour days,
2N/A ignoring leap years), months (defined as 30 24-hour days), weeks,
2N/A days, hours, or minutes, respectively. Without a suffix, the offset
2N/A is computed in seconds. To explicitly prevent a date from being
2N/A set, use 'none' or 'never'.
2N/A </para>
2N/A
2N/A <variablelist>
2N/A <varlistentry>
2N/A <term>-P <replaceable class="parameter">date/offset</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Sets the date on which a key is to be published to the zone.
2N/A After that date, the key will be included in the zone but will
2N/A not be used to sign it.
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A <varlistentry>
2N/A <term>-D <replaceable class="parameter">date/offset</replaceable></term>
2N/A <listitem>
2N/A <para>
2N/A Sets the date on which the key is to be deleted. After that
2N/A date, the key will no longer be included in the zone. (It
2N/A may remain in the key repository, however.)
2N/A </para>
2N/A </listitem>
2N/A </varlistentry>
2N/A
2N/A </variablelist>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>FILES</title>
2N/A <para>
2N/A A keyfile can be designed by the key identification
2N/A <filename>Knnnn.+aaa+iiiii</filename> or the full file name
2N/A <filename>Knnnn.+aaa+iiiii.key</filename> as generated by
2N/A <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>.
2N/A </para>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>SEE ALSO</title>
2N/A <para><citerefentry>
2N/A <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
2N/A </citerefentry>,
2N/A <citerefentry>
2N/A <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
2N/A </citerefentry>,
2N/A <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
2N/A <citetitle>RFC 5011</citetitle>.
2N/A </para>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>AUTHOR</title>
2N/A <para><corpauthor>Internet Systems Consortium</corpauthor>
2N/A </para>
2N/A </refsect1>
2N/A
2N/A</refentry><!--
2N/A - Local variables:
2N/A - mode: sgml
2N/A - End:
2N/A-->
2N/A