dnssec-settime.docbook revision f80b665135127a12ca503c8830aa465aa1ddd17d
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw [<!ENTITY mdash "&#8212;">]>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!--
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw -
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Permission to use, copy, modify, and/or distribute this software for any
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - purpose with or without fee is hereby granted, provided that the above
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - copyright notice and this permission notice appear in all copies.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw -
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - PERFORMANCE OF THIS SOFTWARE.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw-->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!-- $Id: dnssec-settime.docbook,v 1.7 2009/11/03 21:44:46 each Exp $ -->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<refentry id="man.dnssec-settime">
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <refentryinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <date>July 15, 2009</date>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refentryinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refmeta>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refentrytitle><application>dnssec-settime</application></refentrytitle>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <manvolnum>8</manvolnum>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refmiscinfo>BIND9</refmiscinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refmeta>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refname><application>dnssec-settime</application></refname>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <docinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <copyright>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <year>2009</year>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </copyright>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </docinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsynopsisdiv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <cmdsynopsis>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <command>dnssec-settime</command>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-f</option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
bbf6f00c25b6a2bed23c35eac6d62998ecdb338cJordan Brown <arg><option>-h</option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <arg choice="req">keyfile</arg>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb </cmdsynopsis>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb </refsynopsisdiv>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <refsect1>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <title>DESCRIPTION</title>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <para><command>dnssec-settime</command>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb reads a DNSSEC private key file and sets the key timing metadata
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb as specified by the <option>-P</option>, <option>-A</option>,
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <option>-R</option>, <option>-I</option>, and <option>-D</option>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb options. The metadata can then be used by
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <command>dnssec-signzone</command> or other signing software to
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb determine when a key is to be published, whether it should be
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb used for signing a zone, etc.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb <para>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb If none of these options is set on the command line,
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States then <command>dnssec-settime</command> simply prints the key timing
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw metadata already stored in the key.
7b59d02d2a384be9a08087b14defadd214b3c1ddjb </para>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw When key metadata fields are changed, both files of a key
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw pair (<filename>Knnnn.+aaa+iiiii.key</filename> and
b89a8333f5e1f75ec0c269b22524bd2eccb972banatalie li - Sun Microsystems - Irvine United States <filename>Knnnn.+aaa+iiiii.private</filename>) are regenerated.
b89a8333f5e1f75ec0c269b22524bd2eccb972banatalie li - Sun Microsystems - Irvine United States Metadata fields are stored in the private file. A human-readable
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw description of the metadata is also placed in comments in the key
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw file.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsect1>
3b13a1ef7511135ec0c75b5f94de8075454efd79Thomas Keiser <title>OPTIONS</title>
c8ec8eea9849cac239663c46be8a7f5d2ba7ca00jose borrego
c8ec8eea9849cac239663c46be8a7f5d2ba7ca00jose borrego <variablelist>
c8ec8eea9849cac239663c46be8a7f5d2ba7ca00jose borrego <varlistentry>
3b13a1ef7511135ec0c75b5f94de8075454efd79Thomas Keiser <term>-f</term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb <para>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb Force an update of an old-format key with no metadata fields.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Without this option, <command>dnssec-settime</command> will
fail when attempting to update a legacy key. With this option,
the key will be recreated in the new format, but with the
original key data retained. The key's creation date will be
set to the present time.
</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>-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>-E <replaceable class="parameter">engine</replaceable></term>
<listitem>
<para>
Use the given OpenSSL engine. When compiled with PKCS#11 support
it defaults to pkcs11; the empty name resets it to no engine.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>TIMING OPTIONS</title>
<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 unset a date, use 'none'.
</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>-A <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-R <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-I <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
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>
</refsect1>
<refsect1>
<title>PRINTING OPTIONS</title>
<para>
<command>dnssec-settime</command> can also be used to print the
timing metadata associated with a key.
</para>
<variablelist>
<varlistentry>
<term>-u</term>
<listitem>
<para>
Print times in UNIX epoch format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">C/P/A/R/U/D/all</replaceable></term>
<listitem>
<para>
Print a specific metadata value or set of metadata values.
The <option>-p</option> option may be followed by one or more
of the following letters to indicate which value or values to print:
<option>C</option> for the creation date,
<option>P</option> for the publication date,
<option>A</option> for the activation date,
<option>R</option> for the revokation date,
<option>U</option> for the unpublication date, or
<option>D</option> for the deletion date.
To print all of the metadata, use <option>-p all</option>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<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>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->