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

   1 <!--
   2  - Copyright (C) 2009, 2011, 2014, 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-revoke</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-revoke"></a><div class="titlepage"></div>
  24 <div class="refnamediv">
  25 <h2>Name</h2>
  26 <p><span class="application">dnssec-revoke</span> &#8212; Set the REVOKED bit on a DNSSEC key</p>
  27 </div>
  28 <div class="refsynopsisdiv">
  29 <h2>Synopsis</h2>
  30 <div class="cmdsynopsis"><p><code class="command">dnssec-revoke</code>  [<code class="option">-hr</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f</code>] [<code class="option">-R</code>] {keyfile}</p></div>
  31 </div>
  32 <div class="refsection">
  33 <a name="id-1.6"></a><h2>DESCRIPTION</h2>
  34 <p><span class="command"><strong>dnssec-revoke</strong></span>
  35       reads a DNSSEC key file, sets the REVOKED bit on the key as defined
  36       in RFC 5011, and creates a new pair of key files containing the
  37       now-revoked key.
  38     </p>
  39 </div>
  40 <div class="refsection">
  41 <a name="id-1.7"></a><h2>OPTIONS</h2>
  42 <div class="variablelist"><dl class="variablelist">
  43 <dt><span class="term">-h</span></dt>
  44 <dd><p>
  45             Emit usage message and exit.
  46           </p></dd>
  47 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  48 <dd><p>
  49             Sets the directory in which the key files are to reside.
  50           </p></dd>
  51 <dt><span class="term">-r</span></dt>
  52 <dd><p>
  53             After writing the new keyset files remove the original keyset
  54             files.
  55           </p></dd>
  56 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  57 <dd><p>
  58             Sets the debugging level.
  59           </p></dd>
  60 <dt><span class="term">-V</span></dt>
  61 <dd><p>
  62             Prints version information.
  63           </p></dd>
  64 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  65 <dd><p>
  66             Use the given OpenSSL engine. When compiled with PKCS#11 support
  67             it defaults to pkcs11; the empty name resets it to no engine.
  68           </p></dd>
  69 <dt><span class="term">-f</span></dt>
  70 <dd><p>
  71             Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to
  72             write the new key pair even if a file already exists matching
  73             the algorithm and key ID of the revoked key.
  74           </p></dd>
  75 <dt><span class="term">-R</span></dt>
  76 <dd><p>
  77             Print the key tag of the key with the REVOKE bit set but do
  78             not revoke the key.
  79           </p></dd>
  80 </dl></div>
  81 </div>
  82 <div class="refsection">
  83 <a name="id-1.8"></a><h2>SEE ALSO</h2>
  84 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
  85       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
  86       <em class="citetitle">RFC 5011</em>.
  87     </p>
  88 </div>
  89 </div></body>
  90 </html>