dnssec-dsfromkey.docbook revision 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster<!--
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster -
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - Permission to use, copy, modify, and/or distribute this software for any
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - purpose with or without fee is hereby granted, provided that the above
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - copyright notice and this permission notice appear in all copies.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster -
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster - PERFORMANCE OF THIS SOFTWARE.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster-->
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster<!-- Converted by db4-upgrade version 1.0 -->
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-dsfromkey">
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <info>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <date>2012-05-02</date>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </info>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refentryinfo>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <corpname>ISC</corpname>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </refentryinfo>
d1b57e78cf72f41c7c6a52bd7c2a6d6aa4da6ba4Craig McDonnell
98edafaa1060580ef39bce8710345d9fe25b5b04Jaco Jooste <refmeta>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refentrytitle><application>dnssec-dsfromkey</application></refentrytitle>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <manvolnum>8</manvolnum>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refmiscinfo>BIND9</refmiscinfo>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </refmeta>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refnamediv>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refname><application>dnssec-dsfromkey</application></refname>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refpurpose>DNSSEC DS RR generation tool</refpurpose>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </refnamediv>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <docinfo>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <copyright>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2008</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2009</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2010</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2011</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2012</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2014</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <year>2015</year>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </copyright>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </docinfo>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refsynopsisdiv>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <cmdsynopsis sepchar=" ">
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <command>dnssec-dsfromkey</command>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-1</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-2</option></arg>
98edafaa1060580ef39bce8710345d9fe25b5b04Jaco Jooste <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-C</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">TTL</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="req" rep="norepeat">keyfile</arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </cmdsynopsis>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <cmdsynopsis sepchar=" ">
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <command>dnssec-dsfromkey</command>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="req" rep="norepeat">-s</arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-1</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-2</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-s</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">TTL</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">file</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-A</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="req" rep="norepeat">dnsname</arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </cmdsynopsis>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <cmdsynopsis sepchar=" ">
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <command>dnssec-dsfromkey</command>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-h</option></arg>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <arg choice="opt" rep="norepeat"><option>-V</option></arg>
d1b57e78cf72f41c7c6a52bd7c2a6d6aa4da6ba4Craig McDonnell </cmdsynopsis>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </refsynopsisdiv>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <refsection><info><title>DESCRIPTION</title></info>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para><command>dnssec-dsfromkey</command>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster outputs the Delegation Signer (DS) resource record (RR), as defined in
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster RFC 3658 and RFC 4509, for the given key(s).
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </refsection>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
d1b57e78cf72f41c7c6a52bd7c2a6d6aa4da6ba4Craig McDonnell <refsection><info><title>OPTIONS</title></info>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <variablelist>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-1</term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Use SHA-1 as the digest algorithm (the default is to use
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster both SHA-1 and SHA-256).
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-2</term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Use SHA-256 as the digest algorithm.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-a <replaceable class="parameter">algorithm</replaceable></term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Select the digest algorithm. The value of
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <option>algorithm</option> must be one of SHA-1 (SHA1),
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster SHA-256 (SHA256), GOST or SHA-384 (SHA384).
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster These values are case insensitive.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-C</term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Generate CDS records rather than DS records. This is mutually
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster exclusive with generating lookaside records.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-T <replaceable class="parameter">TTL</replaceable></term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Specifies the TTL of the DS records.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-K <replaceable class="parameter">directory</replaceable></term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Look for key files (or, in keyset mode,
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <filename>keyset-</filename> files) in
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <option>directory</option>.
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster </varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <varlistentry>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <term>-f <replaceable class="parameter">file</replaceable></term>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <listitem>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <para>
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster Zone file mode: in place of the keyfile name, the argument is
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster the DNS domain name of a zone master file, which can be read
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster from <option>file</option>. If the zone name is the same as
869a36e2649ae064c98063cf1e55198488d78d12Allan Foster <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. This makes it
possible to use the output of the <command>dig</command>
command as input, as in:
</para>
<para>
<userinput>dig dnskey example.com | dnssec-dsfromkey -f - example.com</userinput>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-A</term>
<listitem>
<para>
Include ZSKs when generating DS records. Without this option,
only keys which have the KSK flag set will be converted to DS
records and printed. Useful only in zone file mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-l <replaceable class="parameter">domain</replaceable></term>
<listitem>
<para>
Generate a DLV set instead of a DS set. The specified
<option>domain</option> is appended to the name for each
record in the set.
The DNSSEC Lookaside Validation (DLV) RR is described
in RFC 4431. This is mutually exclusive with generating
CDS records.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
<listitem>
<para>
Keyset mode: in place of the keyfile name, the argument is
the DNS domain name of a keyset file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-c <replaceable class="parameter">class</replaceable></term>
<listitem>
<para>
Specifies the DNS class (default is IN). Useful only
in keyset or zone file mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v <replaceable class="parameter">level</replaceable></term>
<listitem>
<para>
Sets the debugging level.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem>
<para>
Prints usage information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>
Prints version information.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection><info><title>EXAMPLE</title></info>
<para>
To build the SHA-256 DS RR from the
<userinput>Kexample.com.+003+26160</userinput>
keyfile name, the following command would be issued:
</para>
<para><userinput>dnssec-dsfromkey -2 Kexample.com.+003+26160</userinput>
</para>
<para>
The command would print something like:
</para>
<para><userinput>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</userinput>
</para>
</refsection>
<refsection><info><title>FILES</title></info>
<para>
The 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>
<para>
The keyset file name is built from the <option>directory</option>,
the string <filename>keyset-</filename> and the
<option>dnsname</option>.
</para>
</refsection>
<refsection><info><title>CAVEAT</title></info>
<para>
A keyfile error can give a "file not found" even if the file exists.
</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 3658</citetitle>,
<citetitle>RFC 4431</citetitle>.
<citetitle>RFC 4509</citetitle>.
</para>
</refsection>
</refentry>