bind/doc/arm/man.dnssec-revoke.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
 - Copyright (C) 2000-2017 Internet Systems Consortium, Inc. ("ISC")
 - 
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-revoke</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-keymgr.html" title="dnssec-keymgr">
<link rel="next" href="man.dnssec-settime.html" title="dnssec-settime">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center"><span class="application">dnssec-revoke</span></th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="man.dnssec-keymgr.html">Prev</a><EFBFBD></td>
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-settime.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry">
<a name="man.dnssec-revoke"></a><div class="titlepage"></div>
  
  
  <div class="refnamediv">
<h2>Name</h2>
<p>
    <span class="application">dnssec-revoke</span>
     &#8212; set the REVOKED bit on a DNSSEC key
  </p>
</div>

  
  <div class="refsynopsisdiv">
<h2>Synopsis</h2>
    <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>
  </div>

  <div class="refsection">
<a name="id-1.14.14.7"></a><h2>DESCRIPTION</h2>

    <p><span class="command"><strong>dnssec-revoke</strong></span>
      reads a DNSSEC key file, sets the REVOKED bit on the key as defined
      in RFC 5011, and creates a new pair of key files containing the
      now-revoked key.
    </p>
  </div>

  <div class="refsection">
<a name="id-1.14.14.8"></a><h2>OPTIONS</h2>


    <div class="variablelist"><dl class="variablelist">
<dt><span class="term">-h</span></dt>
<dd>
	  <p>
	    Emit usage message and exit.
	  </p>
        </dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd>
          <p>
            Sets the directory in which the key files are to reside.
          </p>
        </dd>
<dt><span class="term">-r</span></dt>
<dd>
	  <p>
	    After writing the new keyset files remove the original keyset
	    files.
	  </p>
        </dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
<dd>
          <p>
            Sets the debugging level.
          </p>
        </dd>
<dt><span class="term">-V</span></dt>
<dd>
	  <p>
	    Prints version information.
	  </p>
        </dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
          <p>
            Specifies the cryptographic hardware to use, when applicable.
          </p>
          <p>
            When BIND is built with OpenSSL PKCS#11 support, this defaults
            to the string "pkcs11", which identifies an OpenSSL engine
            that can drive a cryptographic accelerator or hardware service
            module.  When BIND is built with native PKCS#11 cryptography
            (--enable-native-pkcs11), it defaults to the path of the PKCS#11
            provider library specified via "--with-pkcs11".
          </p>
        </dd>
<dt><span class="term">-f</span></dt>
<dd>
          <p>
            Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to
            write the new key pair even if a file already exists matching
            the algorithm and key ID of the revoked key.
          </p>
        </dd>
<dt><span class="term">-R</span></dt>
<dd>
          <p>
	    Print the key tag of the key with the REVOKE bit set but do
	    not revoke the key.
          </p>
        </dd>
</dl></div>
  </div>

  <div class="refsection">
<a name="id-1.14.14.9"></a><h2>SEE ALSO</h2>

    <p><span class="citerefentry">
        <span class="refentrytitle">dnssec-keygen</span>(8)
      </span>,
      <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
      <em class="citetitle">RFC 5011</em>.
    </p>
  </div>

</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.dnssec-keymgr.html">Prev</a><EFBFBD></td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-settime.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">dnssec-keymgr</span><EFBFBD></td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top"><EFBFBD><span class="application">dnssec-settime</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.12.0-pre-alpha</p>
</body>
</html>
-.   [doc]           Add DOCTYPE and lang attribute to <html> tags.
                        [RT #42587]

											
										
										
											2016-08-26 15:14:04 +10:00
+								<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<!--
-												regen master

											
										
										
											2017-01-06 01:05:20 +00:00
+								 - Copyright (C) 2000-2017 Internet Systems Consortium, Inc. ("ISC")
-												regen

											
										
										
											2009-07-21 07:02:09 +00:00
+								 -
-												regen master

											
										
										
											2016-07-21 07:11:01 +00:00
+								 - This Source Code Form is subject to the terms of the Mozilla Public
 								 - License, v. 2.0. If a copy of the MPL was not distributed with this
 								 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								-->
-.   [doc]           Add DOCTYPE and lang attribute to <html> tags.
                        [RT #42587]

											
										
										
											2016-08-26 15:14:04 +10:00
+								<html lang="en">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<head>
 								<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 								<title>dnssec-revoke</title>
-												regen master

											
										
										
											2015-10-07 04:11:09 +00:00
+								<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
-												[master] upgrade doc toolchain

4237.	[doc]		Upgraded documentation toolchain to use DocBook 5
			and dblatex. [RT #40766]

											
										
										
											2015-10-05 21:59:35 -07:00
+								<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
-												regen master

											
										
										
											2015-01-09 01:05:02 +00:00
+								<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<link rel="prev" href="man.dnssec-keymgr.html" title="dnssec-keymgr">
-												regen

											
										
										
											2009-07-19 04:27:56 +00:00
+								<link rel="next" href="man.dnssec-settime.html" title="dnssec-settime">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</head>
 								<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 								<div class="navheader">
 								<table width="100%" summary="Navigation header">
 								<tr><th colspan="3" align="center"><span class="application">dnssec-revoke</span></th></tr>
 								<tr>
 								<td width="20%" align="left">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<a accesskey="p" href="man.dnssec-keymgr.html">Prev</a><EFBFBD></td>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<th width="60%" align="center">Manual pages</th>
-												regen

											
										
										
											2009-07-19 04:27:56 +00:00
+								<td width="20%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-settime.html">Next</a>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</td>
 								</tr>
 								</table>
 								<hr>
 								</div>
-												regen master

											
										
										
											2015-10-07 04:11:09 +00:00
+								<div class="refentry">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<a name="man.dnssec-revoke"></a><div class="titlepage"></div>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
 								  <div class="refnamediv">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<h2>Name</h2>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<p>
 								    <span class="application">dnssec-revoke</span>
 								     &#8212; set the REVOKED bit on a DNSSEC key
 								  </p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</div>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
 								  <div class="refsynopsisdiv">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<h2>Synopsis</h2>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								    <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>
 								  </div>
 								  <div class="refsection">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<a name="id-1.14.14.7"></a><h2>DESCRIPTION</h2>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
 								    <p><span class="command"><strong>dnssec-revoke</strong></span>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								      reads a DNSSEC key file, sets the REVOKED bit on the key as defined
-												regen

											
										
										
											2009-07-21 01:13:24 +00:00
+								      in RFC 5011, and creates a new pair of key files containing the
 								      now-revoked key.
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								    </p>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								  </div>
 								  <div class="refsection">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<a name="id-1.14.14.8"></a><h2>OPTIONS</h2>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
 								    <div class="variablelist"><dl class="variablelist">
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<dt><span class="term">-h</span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 									  <p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+									    Emit usage message and exit.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+									  </p>
 								        </dd>
-												regen

											
										
										
											2009-07-19 04:27:56 +00:00
+								<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 								          <p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								            Sets the directory in which the key files are to reside.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          </p>
 								        </dd>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<dt><span class="term">-r</span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 									  <p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+									    After writing the new keyset files remove the original keyset
 									    files.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+									  </p>
 								        </dd>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 								          <p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								            Sets the debugging level.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          </p>
 								        </dd>
-												regen master

											
										
										
											2014-06-17 01:05:10 +00:00
+								<dt><span class="term">-V</span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 									  <p>
-												regen master

											
										
										
											2014-06-17 01:05:10 +00:00
+									    Prints version information.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+									  </p>
 								        </dd>
-												regen

											
										
										
											2009-10-06 01:14:42 +00:00
+								<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
-												regen master

											
										
										
											2014-01-16 01:05:38 +00:00
+								<dd>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          <p>
-												regen master

											
										
										
											2014-01-16 01:05:38 +00:00
+								            Specifies the cryptographic hardware to use, when applicable.
 								          </p>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          <p>
-												regen master

											
										
										
											2014-01-16 01:05:38 +00:00
+								            When BIND is built with OpenSSL PKCS#11 support, this defaults
 								            to the string "pkcs11", which identifies an OpenSSL engine
 								            that can drive a cryptographic accelerator or hardware service
 								            module.  When BIND is built with native PKCS#11 cryptography
 								            (--enable-native-pkcs11), it defaults to the path of the PKCS#11
 								            provider library specified via "--with-pkcs11".
 								          </p>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								        </dd>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<dt><span class="term">-f</span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 								          <p>
-												[master] upgrade doc toolchain

4237.	[doc]		Upgraded documentation toolchain to use DocBook 5
			and dblatex. [RT #40766]

											
										
										
											2015-10-05 21:59:35 -07:00
+								            Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								            write the new key pair even if a file already exists matching
 								            the algorithm and key ID of the revoked key.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          </p>
 								        </dd>
-												regen HEAD

											
										
										
											2011-10-21 01:14:51 +00:00
+								<dt><span class="term">-R</span></dt>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								<dd>
 								          <p>
-												regen HEAD

											
										
										
											2011-10-21 01:14:51 +00:00
+									    Print the key tag of the key with the REVOKE bit set but do
 									    not revoke the key.
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								          </p>
 								        </dd>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</dl></div>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								  </div>
 								  <div class="refsection">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<a name="id-1.14.14.9"></a><h2>SEE ALSO</h2>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
 								    <p><span class="citerefentry">
 								        <span class="refentrytitle">dnssec-keygen</span>(8)
 								      </span>,
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								      <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 								      <em class="citetitle">RFC 5011</em>.
 								    </p>
-												regen master

											
										
										
											2016-12-07 01:05:34 +00:00
+								  </div>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</div>
 								<div class="navfooter">
 								<hr>
 								<table width="100%" summary="Navigation footer">
 								<tr>
 								<td width="40%" align="left">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<a accesskey="p" href="man.dnssec-keymgr.html">Prev</a><EFBFBD></td>
-												regen master

											
										
										
											2015-01-09 01:05:02 +00:00
+								<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
-												regen

											
										
										
											2009-07-19 04:27:56 +00:00
+								<td width="40%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-settime.html">Next</a>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</td>
 								</tr>
 								<tr>
 								<td width="40%" align="left" valign="top">
-												regen master

											
										
										
											2016-08-25 01:04:54 +00:00
+								<span class="application">dnssec-keymgr</span><EFBFBD></td>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
-												regen

											
										
										
											2009-07-19 04:27:56 +00:00
+								<td width="40%" align="right" valign="top"><EFBFBD><span class="application">dnssec-settime</span>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</td>
 								</tr>
 								</table>
 								</div>
-												regen master

											
										
										
											2017-01-10 01:04:52 +00:00
+								<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.12.0-pre-alpha</p>
-												dnssec-revoke docbook fix

											
										
										
											2009-06-30 03:20:26 +00:00
+								</body>
 								</html>