268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein [<!ENTITY mdash "&#8212;">]>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentry id="man.dnssec-settime">

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentryinfo>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <date>July 15, 2009</date>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refentryinfo>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmeta>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle><application>dnssec-settime</application></refentrytitle>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <manvolnum>8</manvolnum>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmiscinfo>BIND9</refmiscinfo>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refmeta>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname><application>dnssec-settime</application></refname>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refnamediv>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <docinfo>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <copyright>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2009</year>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2010</year>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </docinfo>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsynopsisdiv>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <cmdsynopsis>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>dnssec-settime</command>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-f</option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-h</option></arg>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">keyfile</arg>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </cmdsynopsis>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsynopsisdiv>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>DESCRIPTION</title>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para><command>dnssec-settime</command>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein reads a DNSSEC private key file and sets the key timing metadata

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson as specified by the <option>-P</option>, <option>-A</option>,

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <option>-R</option>, <option>-I</option>, and <option>-D</option>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein options. The metadata can then be used by

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>dnssec-signzone</command> or other signing software to

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson determine when a key is to be published, whether it should be

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson used for signing a zone, etc.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If none of these options is set on the command line,

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein then <command>dnssec-settime</command> simply prints the key timing

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson metadata already stored in the key.

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </para>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson When key metadata fields are changed, both files of a key

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein pair (<filename>Knnnn.+aaa+iiiii.key</filename> and

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <filename>Knnnn.+aaa+iiiii.private</filename>) are regenerated.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Metadata fields are stored in the private file. A human-readable

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson description of the metadata is also placed in comments in the key

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson file.

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </para>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </refsect1>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refsect1>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <title>OPTIONS</title>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <variablelist>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-f</term>

ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Force an update of an old-format key with no metadata fields.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Without this option, <command>dnssec-settime</command> will

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein fail when attempting to update a legacy key. With this option,

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the key will be recreated in the new format, but with the

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein original key data retained. The key's creation date will be

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein set to the present time.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-K <replaceable class="parameter">directory</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the directory in which the key files are to reside.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-h</term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Emit usage message and exit.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-v <replaceable class="parameter">level</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the debugging level.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-E <replaceable class="parameter">engine</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Use the given OpenSSL engine. When compiled with PKCS#11 support

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein it defaults to pkcs11; the empty name resets it to no engine.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>TIMING OPTIONS</title>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If the argument begins with a '+' or '-', it is interpreted as

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein an offset from the present time. For convenience, if such an offset

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein then the offset is computed in years (defined as 365 24-hour days,

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein ignoring leap years), months (defined as 30 24-hour days), weeks,

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein days, hours, or minutes, respectively. Without a suffix, the offset

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is computed in seconds. To unset a date, use 'none'.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <variablelist>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-P <replaceable class="parameter">date/offset</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the date on which a key is to be published to the zone.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein After that date, the key will be included in the zone but will

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein not be used to sign it.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-A <replaceable class="parameter">date/offset</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the date on which the key is to be activated. After that

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein date, the key will be included in the zone and used to sign

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein it.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-R <replaceable class="parameter">date/offset</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the date on which the key is to be revoked. After that

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein date, the key will be flagged as revoked. It will be included

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein in the zone and will be used to sign it.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-I <replaceable class="parameter">date/offset</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the date on which the key is to be retired. After that

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein date, the key will still be included in the zone, but it

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein will not be used to sign it.

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-D <replaceable class="parameter">date/offset</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sets the date on which the key is to be deleted. After that

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein date, the key will no longer be included in the zone. (It

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein may remain in the key repository, however.)

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-S <replaceable class="parameter">predecessor key</replaceable></term>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Select a key for which the key being modified will be an

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein explicit successor. The name, algorithm, size, and type of the

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein predecessor key must exactly match those of the key being

268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein modified. The activation date of the successor key will be set

to the inactivation date of the predecessor. The publication

date will be set to the activation date minus the prepublication

interval, which defaults to 30 days.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-i <replaceable class="parameter">interval</replaceable></term>

<listitem>

<para>

Sets the prepublication interval for a key. If set, then

the publication and activation dates must be separated by at least

this much time. If the activation date is specified but the

publication date isn't, then the publication date will default

to this much time before the activation date; conversely, if

the publication date is specified but activation date isn't,

then activation will be set to this much time after publication.

</para>

<para>

If the key is being set to be an explicit successor to another

key, then the default prepublication interval is 30 days;

otherwise it is zero.

</para>

<para>

As with date offsets, if the argument is followed by one of

the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the

interval is measured in years, months, weeks, days, hours,

or minutes, respectively. Without a suffix, the interval is

measured in seconds.

</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/I/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 revocation date,

<option>I</option> for the inactivation 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><!--