Update repub branch u/fanf2/patch to rebasing branch u/fanf2/rebasing revision v9_15_...
[ipreg/bind9.git] / bin / dnssec / dnssec-revoke.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--
3 - Copyright (C) 2009, 2011, 2014-2016, 2018, 2019 Internet Systems Consortium, Inc. ("ISC")
4 -
5 - This Source Code Form is subject to the terms of the Mozilla Public
6 - License, v. 2.0. If a copy of the MPL was not distributed with this
7 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 -->
9 <html lang="en">
10 <head>
11 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
12 <title>dnssec-revoke</title>
13 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
14 </head>
15 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
16 <a name="man.dnssec-revoke"></a><div class="titlepage"></div>
17
18
19
20
21
22 <div class="refnamediv">
23 <h2>Name</h2>
24 <p>
25 <span class="application">dnssec-revoke</span>
26 &#8212; set the REVOKED bit on a DNSSEC key
27 </p>
28 </div>
29
30
31
32 <div class="refsynopsisdiv">
33 <h2>Synopsis</h2>
34 <div class="cmdsynopsis"><p>
35 <code class="command">dnssec-revoke</code>
36 [<code class="option">-hr</code>]
37 [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
38 [<code class="option">-V</code>]
39 [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
40 [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
41 [<code class="option">-f</code>]
42 [<code class="option">-R</code>]
43 {keyfile}
44 </p></div>
45 </div>
46
47 <div class="refsection">
48 <a name="id-1.7"></a><h2>DESCRIPTION</h2>
49
50 <p><span class="command"><strong>dnssec-revoke</strong></span>
51 reads a DNSSEC key file, sets the REVOKED bit on the key as defined
52 in RFC 5011, and creates a new pair of key files containing the
53 now-revoked key.
54 </p>
55 </div>
56
57 <div class="refsection">
58 <a name="id-1.8"></a><h2>OPTIONS</h2>
59
60
61 <div class="variablelist"><dl class="variablelist">
62 <dt><span class="term">-h</span></dt>
63 <dd>
64 <p>
65 Emit usage message and exit.
66 </p>
67 </dd>
68 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
69 <dd>
70 <p>
71 Sets the directory in which the key files are to reside.
72 </p>
73 </dd>
74 <dt><span class="term">-r</span></dt>
75 <dd>
76 <p>
77 After writing the new keyset files remove the original keyset
78 files.
79 </p>
80 </dd>
81 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
82 <dd>
83 <p>
84 Sets the debugging level.
85 </p>
86 </dd>
87 <dt><span class="term">-V</span></dt>
88 <dd>
89 <p>
90 Prints version information.
91 </p>
92 </dd>
93 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
94 <dd>
95 <p>
96 Specifies the cryptographic hardware to use, when applicable.
97 </p>
98 <p>
99 When BIND is built with OpenSSL PKCS#11 support, this defaults
100 to the string "pkcs11", which identifies an OpenSSL engine
101 that can drive a cryptographic accelerator or hardware service
102 module. When BIND is built with native PKCS#11 cryptography
103 (--enable-native-pkcs11), it defaults to the path of the PKCS#11
104 provider library specified via "--with-pkcs11".
105 </p>
106 </dd>
107 <dt><span class="term">-f</span></dt>
108 <dd>
109 <p>
110 Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to
111 write the new key pair even if a file already exists matching
112 the algorithm and key ID of the revoked key.
113 </p>
114 </dd>
115 <dt><span class="term">-R</span></dt>
116 <dd>
117 <p>
118 Print the key tag of the key with the REVOKE bit set but do
119 not revoke the key.
120 </p>
121 </dd>
122 </dl></div>
123 </div>
124
125 <div class="refsection">
126 <a name="id-1.9"></a><h2>SEE ALSO</h2>
127
128 <p><span class="citerefentry">
129 <span class="refentrytitle">dnssec-keygen</span>(8)
130 </span>,
131 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
132 <em class="citetitle">RFC 5011</em>.
133 </p>
134 </div>
135
136 </div></body>
137 </html>