external/bsd/bind/dist/doc/arm/man.dnssec-importkey.html

   1 <!--
   2  - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id: man.dnssec-importkey.html,v 1.5 2015/09/03 07:33:34 christos Exp $ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>dnssec-importkey</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
  25 <link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
  26 <link rel="next" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
  27 </head>
  28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29 <div class="navheader">
  30 <table width="100%" summary="Navigation header">
  31 <tr><th colspan="3" align="center"><span class="application">dnssec-importkey</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
  35 <th width="60%" align="center">Manual pages</th>
  36 <td width="20%" align="right"> <a accesskey="n" href="man.dnssec-keyfromlabel.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.dnssec-importkey"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">dnssec-importkey</span> &#8212; Import DNSKEY records from external systems so they can be managed.</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code>  [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] {<code class="option">keyfile</code>}</p></div>
  51 <div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code>  {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>} [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">dnsname</code>]</p></div>
  52 </div>
  53 <div class="refsect1" lang="en">
  54 <a name="id2619964"></a><h2>DESCRIPTION</h2>
  55 <p><span><strong class="command">dnssec-importkey</strong></span>
  56       reads a public DNSKEY record and generates a pair of
  57       .key/.private files.  The DNSKEY record may be read from an
  58       existing .key file, in which case a corresponding .private file
  59       will be generated, or it may be read from any other file or
  60       from the standard input, in which case both .key and .private
  61       files will be generated.
  62     </p>
  63 <p>
  64       The newly-created .private file does <span class="emphasis"><em>not</em></span>
  65       contain private key data, and cannot be used for signing.
  66       However, having a .private file makes it possible to set
  67       publication (<code class="option">-P</code>) and deletion
  68       (<code class="option">-D</code>) times for the key, which means the
  69       public key can be added to and removed from the DNSKEY RRset
  70       on schedule even if the true private key is stored offline.
  71     </p>
  72 </div>
  73 <div class="refsect1" lang="en">
  74 <a name="id2619992"></a><h2>OPTIONS</h2>
  75 <div class="variablelist"><dl>
  76 <dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
  77 <dd>
  78 <p>
  79             Zone file mode: instead of a public keyfile name, the argument
  80             is the DNS domain name of a zone master file, which can be read
  81             from <code class="option">file</code>.  If the domain name is the same as
  82             <code class="option">file</code>, then it may be omitted.
  83           </p>
  84 <p>
  85             If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
  86             the zone data is read from the standard input.
  87           </p>
  88 </dd>
  89 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  90 <dd><p>
  91             Sets the directory in which the key files are to reside.
  92           </p></dd>
  93 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
  94 <dd><p>
  95             Sets the default TTL to use for this key when it is converted
  96             into a DNSKEY RR.  If the key is imported into a zone,
  97             this is the TTL that will be used for it, unless there was
  98             already a DNSKEY RRset in place, in which case the existing TTL
  99             would take precedence.  Setting the default TTL to
 100             <code class="literal">0</code> or <code class="literal">none</code> removes it.
 101           </p></dd>
 102 <dt><span class="term">-h</span></dt>
 103 <dd><p>
 104             Emit usage message and exit.
 105           </p></dd>
 106 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 107 <dd><p>
 108             Sets the debugging level.
 109           </p></dd>
 110 <dt><span class="term">-V</span></dt>
 111 <dd><p>
 112             Prints version information.
 113           </p></dd>
 114 </dl></div>
 115 </div>
 116 <div class="refsect1" lang="en">
 117 <a name="id2620130"></a><h2>TIMING OPTIONS</h2>
 118 <p>
 119       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 120       If the argument begins with a '+' or '-', it is interpreted as
 121       an offset from the present time.  For convenience, if such an offset
 122       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 123       then the offset is computed in years (defined as 365 24-hour days,
 124       ignoring leap years), months (defined as 30 24-hour days), weeks,
 125       days, hours, or minutes, respectively.  Without a suffix, the offset
 126       is computed in seconds.  To explicitly prevent a date from being
 127       set, use 'none' or 'never'.
 128     </p>
 129 <div class="variablelist"><dl>
 130 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 131 <dd><p>
 132             Sets the date on which a key is to be published to the zone.
 133             After that date, the key will be included in the zone but will
 134             not be used to sign it.
 135           </p></dd>
 136 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 137 <dd><p>
 138             Sets the date on which the key is to be deleted.  After that
 139             date, the key will no longer be included in the zone.  (It
 140             may remain in the key repository, however.)
 141           </p></dd>
 142 </dl></div>
 143 </div>
 144 <div class="refsect1" lang="en">
 145 <a name="id2620177"></a><h2>FILES</h2>
 146 <p>
 147       A keyfile can be designed by the key identification
 148       <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
 149       <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
 150       <span class="refentrytitle">dnssec-keygen</span>(8).
 151     </p>
 152 </div>
 153 <div class="refsect1" lang="en">
 154 <a name="id2620202"></a><h2>SEE ALSO</h2>
 155 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 156       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 157       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 158       <em class="citetitle">RFC 5011</em>.
 159     </p>
 160 </div>
 161 <div class="refsect1" lang="en">
 162 <a name="id2620304"></a><h2>AUTHOR</h2>
 163 <p><span class="corpauthor">Internet Systems Consortium</span>
 164     </p>
 165 </div>
 166 </div>
 167 <div class="navfooter">
 168 <hr>
 169 <table width="100%" summary="Navigation footer">
 170 <tr>
 171 <td width="40%" align="left">
 172 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
 173 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
 174 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keyfromlabel.html">Next</a>
 175 </td>
 176 </tr>
 177 <tr>
 178 <td width="40%" align="left" valign="top">
 179 <span class="application">dnssec-dsfromkey</span> </td>
 180 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 181 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keyfromlabel</span>
 182 </td>
 183 </tr>
 184 </table>
 185 </div>
 186 <p style="text-align: center;">BIND 9.10.2-P4</p>
 187 </body>
 188 </html>