dnssec-importkey.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik<!--
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik -
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - Permission to use, copy, modify, and/or distribute this software for any
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - purpose with or without fee is hereby granted, provided that the above
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - copyright notice and this permission notice appear in all copies.
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik -
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik - PERFORMANCE OF THIS SOFTWARE.
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik-->
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik<!-- Converted by db4-upgrade version 1.0 -->
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-importkey">
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <info>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <date>2014-02-20</date>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </info>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refentryinfo>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <corpname>ISC</corpname>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </refentryinfo>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refmeta>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refentrytitle><application>dnssec-importkey</application></refentrytitle>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <manvolnum>8</manvolnum>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refmiscinfo>BIND9</refmiscinfo>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </refmeta>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refnamediv>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refname><application>dnssec-importkey</application></refname>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refpurpose>Import DNSKEY records from external systems so they can be managed.</refpurpose>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </refnamediv>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <docinfo>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <copyright>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <year>2013</year>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <year>2014</year>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </copyright>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </docinfo>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <refsynopsisdiv>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <cmdsynopsis sepchar=" ">
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <command>dnssec-importkey</command>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-h</option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="opt" rep="norepeat"><option>-V</option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik <arg choice="req" rep="norepeat"><option>keyfile</option></arg>
f28b09f887870c10c8c611beee3c17eaa9ef74f3Lukas Slebodnik </cmdsynopsis>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <cmdsynopsis sepchar=" ">
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <command>dnssec-importkey</command>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="req" rep="norepeat"><option>-f <replaceable class="parameter">filename</replaceable></option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-h</option></arg>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
900778b5afd0143005cfd40cc67ad5086481f7eeLukas Slebodnik <arg choice="opt" rep="norepeat"><option>-V</option></arg>
<arg choice="opt" rep="norepeat"><option>dnsname</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection><info><title>DESCRIPTION</title></info>
<para><command>dnssec-importkey</command>
reads a public DNSKEY record and generates a pair of
.key/.private files. The DNSKEY record may be read from an
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.
</para>
<para>
The newly-created .private file does <emphasis>not</emphasis>
contain private key data, and cannot be used for signing.
However, having a .private file makes it possible to set
publication (<option>-P</option>) and deletion
(<option>-D</option>) 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.
</para>
</refsection>
<refsection><info><title>OPTIONS</title></info>
<variablelist>
<varlistentry>
<term>-f <replaceable class="parameter">filename</replaceable></term>
<listitem>
<para>
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 <option>file</option>. If the domain name is the same as
<option>file</option>, then it may be omitted.
</para>
<para>
If <option>file</option> is set to <literal>"-"</literal>, then
the zone data is read from the standard input.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-K <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>
Sets the directory in which the key files are to reside.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-L <replaceable class="parameter">ttl</replaceable></term>
<listitem>
<para>
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
<literal>0</literal> or <literal>none</literal> removes it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem>
<para>
Emit usage message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v <replaceable class="parameter">level</replaceable></term>
<listitem>
<para>
Sets the debugging level.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>
Prints version information.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection><info><title>TIMING OPTIONS</title></info>
<para>
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'.
</para>
<variablelist>
<varlistentry>
<term>-P <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
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.)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection><info><title>FILES</title></info>
<para>
A keyfile can be designed by the key identification
<filename>Knnnn.+aaa+iiiii</filename> or the full file name
<filename>Knnnn.+aaa+iiiii.key</filename> as generated by
<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>.
</para>
</refsection>
<refsection><info><title>SEE ALSO</title></info>
<para><citerefentry>
<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 9 Administrator Reference Manual</citetitle>,
<citetitle>RFC 5011</citetitle>.
</para>
</refsection>
</refentry>