contrib/bind9/bin/dnssec/dnssec-importkey.html

   1 <!--
   2  - Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and/or distribute this software for any
   5  - purpose with or without fee is hereby granted, provided that the above
   6  - copyright notice and this permission notice appear in all copies.
   7  -
   8  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14  - PERFORMANCE OF THIS SOFTWARE.
  15 -->
  16 <html>
  17 <head>
  18 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  19 <title>dnssec-importkey</title>
  20 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  21 </head>
  22 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
  23 <a name="man.dnssec-importkey"></a><div class="titlepage"></div>
  24 <div class="refnamediv">
  25 <h2>Name</h2>
  26 <p><span class="application">dnssec-importkey</span> &#8212; Import DNSKEY records from external systems so they can be managed.</p>
  27 </div>
  28 <div class="refsynopsisdiv">
  29 <h2>Synopsis</h2>
  30 <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>
  31 <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>
  32 </div>
  33 <div class="refsection">
  34 <a name="id-1.7"></a><h2>DESCRIPTION</h2>
  35 <p><span class="command"><strong>dnssec-importkey</strong></span>
  36       reads a public DNSKEY record and generates a pair of
  37       .key/.private files.  The DNSKEY record may be read from an
  38       existing .key file, in which case a corresponding .private file
  39       will be generated, or it may be read from any other file or
  40       from the standard input, in which case both .key and .private
  41       files will be generated.
  42     </p>
  43 <p>
  44       The newly-created .private file does <span class="emphasis"><em>not</em></span>
  45       contain private key data, and cannot be used for signing.
  46       However, having a .private file makes it possible to set
  47       publication (<code class="option">-P</code>) and deletion
  48       (<code class="option">-D</code>) times for the key, which means the
  49       public key can be added to and removed from the DNSKEY RRset
  50       on schedule even if the true private key is stored offline.
  51     </p>
  52 </div>
  53 <div class="refsection">
  54 <a name="id-1.8"></a><h2>OPTIONS</h2>
  55 <div class="variablelist"><dl class="variablelist">
  56 <dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
  57 <dd>
  58 <p>
  59             Zone file mode: instead of a public keyfile name, the argument
  60             is the DNS domain name of a zone master file, which can be read
  61             from <code class="option">file</code>.  If the domain name is the same as
  62             <code class="option">file</code>, then it may be omitted.
  63           </p>
  64 <p>
  65             If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
  66             the zone data is read from the standard input.
  67           </p>
  68 </dd>
  69 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  70 <dd><p>
  71             Sets the directory in which the key files are to reside.
  72           </p></dd>
  73 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
  74 <dd><p>
  75             Sets the default TTL to use for this key when it is converted
  76             into a DNSKEY RR.  If the key is imported into a zone,
  77             this is the TTL that will be used for it, unless there was
  78             already a DNSKEY RRset in place, in which case the existing TTL
  79             would take precedence.  Setting the default TTL to
  80             <code class="literal">0</code> or <code class="literal">none</code> removes it.
  81           </p></dd>
  82 <dt><span class="term">-h</span></dt>
  83 <dd><p>
  84             Emit usage message and exit.
  85           </p></dd>
  86 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  87 <dd><p>
  88             Sets the debugging level.
  89           </p></dd>
  90 <dt><span class="term">-V</span></dt>
  91 <dd><p>
  92             Prints version information.
  93           </p></dd>
  94 </dl></div>
  95 </div>
  96 <div class="refsection">
  97 <a name="id-1.9"></a><h2>TIMING OPTIONS</h2>
  98 <p>
  99       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 100       If the argument begins with a '+' or '-', it is interpreted as
 101       an offset from the present time.  For convenience, if such an offset
 102       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 103       then the offset is computed in years (defined as 365 24-hour days,
 104       ignoring leap years), months (defined as 30 24-hour days), weeks,
 105       days, hours, or minutes, respectively.  Without a suffix, the offset
 106       is computed in seconds.  To explicitly prevent a date from being
 107       set, use 'none' or 'never'.
 108     </p>
 109 <div class="variablelist"><dl class="variablelist">
 110 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 111 <dd><p>
 112             Sets the date on which a key is to be published to the zone.
 113             After that date, the key will be included in the zone but will
 114             not be used to sign it.
 115           </p></dd>
 116 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 117 <dd><p>
 118             Sets the date on which the key is to be deleted.  After that
 119             date, the key will no longer be included in the zone.  (It
 120             may remain in the key repository, however.)
 121           </p></dd>
 122 </dl></div>
 123 </div>
 124 <div class="refsection">
 125 <a name="id-1.10"></a><h2>FILES</h2>
 126 <p>
 127       A keyfile can be designed by the key identification
 128       <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
 129       <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
 130       <span class="refentrytitle">dnssec-keygen</span>(8).
 131     </p>
 132 </div>
 133 <div class="refsection">
 134 <a name="id-1.11"></a><h2>SEE ALSO</h2>
 135 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 136       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 137       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 138       <em class="citetitle">RFC 5011</em>.
 139     </p>
 140 </div>
 141 </div></body>
 142 </html>