xref: /netbsd-src/external/mpl/bind/dist/bin/dnssec/dnssec-revoke.rst (revision a45db23f655e22f0c2354600d3b3c2cb98abf2dc)
1.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
2..
3.. SPDX-License-Identifier: MPL-2.0
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 https://mozilla.org/MPL/2.0/.
8..
9.. See the COPYRIGHT file distributed with this work for additional
10.. information regarding copyright ownership.
11
12.. highlight: console
13
14.. _man_dnssec-revoke:
15
16dnssec-revoke - set the REVOKED bit on a DNSSEC key
17---------------------------------------------------
18
19Synopsis
20~~~~~~~~
21
22:program:`dnssec-revoke` [**-hr**] [**-v** level] [**-V**] [**-K** directory] [**-E** engine] [**-f**] [**-R**] {keyfile}
23
24Description
25~~~~~~~~~~~
26
27``dnssec-revoke`` reads a DNSSEC key file, sets the REVOKED bit on the
28key as defined in :rfc:`5011`, and creates a new pair of key files
29containing the now-revoked key.
30
31Options
32~~~~~~~
33
34``-h``
35   This option emits a usage message and exits.
36
37``-K directory``
38   This option sets the directory in which the key files are to reside.
39
40``-r``
41   This option indicates to remove the original keyset files after writing the new keyset files.
42
43``-v level``
44   This option sets the debugging level.
45
46``-V``
47   This option prints version information.
48
49``-E engine``
50   This option specifies the cryptographic hardware to use, when applicable.
51
52   When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL
53   engine identifier that drives the cryptographic accelerator or
54   hardware service module (usually ``pkcs11``). When BIND is
55   built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it
56   defaults to the path of the PKCS#11 provider library specified via
57   ``--with-pkcs11``.
58
59``-f``
60   This option indicates a forced overwrite and causes ``dnssec-revoke`` to write the new key pair,
61   even if a file already exists matching the algorithm and key ID of
62   the revoked key.
63
64``-R``
65   This option prints the key tag of the key with the REVOKE bit set, but does not
66   revoke the key.
67
68See Also
69~~~~~~~~
70
71:manpage:`dnssec-keygen(8)`, BIND 9 Administrator Reference Manual, :rfc:`5011`.
72