summaryrefslogtreecommitdiffstats
path: root/doc/arm/man.pkcs11-destroy.html
blob: d6dd46878cb6ebe724b25950e2b816c4a80b53ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
 - Copyright (C) 2000-2019 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>pkcs11-destroy</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.nsec3hash.html" title="nsec3hash">
<link rel="next" href="man.pkcs11-list.html" title="pkcs11-list">
</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">pkcs11-destroy</span></th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="man.nsec3hash.html">Prev</a></td>
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"><a accesskey="n" href="man.pkcs11-list.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry">
<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
  
  

  

  <div class="refnamediv">
<h2>Name</h2>
<p>
    <span class="application">pkcs11-destroy</span>
     &#8212; destroy PKCS#11 objects
  </p>
</div>

  

  <div class="refsynopsisdiv">
<h2>Synopsis</h2>
    <div class="cmdsynopsis"><p>
      <code class="command">pkcs11-destroy</code> 
       [<code class="option">-m <em class="replaceable"><code>module</code></em></code>]
       [<code class="option">-s <em class="replaceable"><code>slot</code></em></code>]
       {
         -i <em class="replaceable"><code>ID</code></em> 
         |   -l <em class="replaceable"><code>label</code></em> 
      }
       [<code class="option">-p <em class="replaceable"><code>PIN</code></em></code>]
       [<code class="option">-w <em class="replaceable"><code>seconds</code></em></code>]
    </p></div>
  </div>

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

    <p>
      <span class="command"><strong>pkcs11-destroy</strong></span> destroys keys stored in a
      PKCS#11 device, identified by their <code class="option">ID</code> or
      <code class="option">label</code>.
    </p>
    <p>
      Matching keys are displayed before being destroyed.  By default,
      there is a five second delay to allow the user to interrupt the
      process before the destruction takes place.
    </p>
  </div>

  <div class="refsection">
<a name="id-1.14.36.8"></a><h2>ARGUMENTS</h2>

    <div class="variablelist"><dl class="variablelist">
<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
<dd>
          <p>
            Specify the PKCS#11 provider module.  This must be the full
            path to a shared library object implementing the PKCS#11 API
            for the device.
          </p>
        </dd>
<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
<dd>
          <p>
            Open the session with the given PKCS#11 slot.  The default is
            slot 0.
          </p>
        </dd>
<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
<dd>
          <p>
            Destroy keys with the given object ID.
          </p>
        </dd>
<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
<dd>
          <p>
            Destroy keys with the given label.
          </p>
        </dd>
<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
<dd>
          <p>
            Specify the PIN for the device.  If no PIN is provided on the
            command line, <span class="command"><strong>pkcs11-destroy</strong></span> will prompt for it.
          </p>
        </dd>
<dt><span class="term">-w <em class="replaceable"><code>seconds</code></em></span></dt>
<dd>
          <p>
            Specify how long to pause before carrying out key destruction.
            The default is five seconds.  If set to <code class="literal">0</code>,
            destruction will be immediate.
          </p>
        </dd>
</dl></div>
  </div>

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

    <p>
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-keygen</span>(8)
      </span>,
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-list</span>(8)
      </span>,
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-tokens</span>(8)
      </span>
    </p>
  </div>

</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.nsec3hash.html">Prev</a></td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right"><a accesskey="n" href="man.pkcs11-list.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">nsec3hash</span></td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top"><span class="application">pkcs11-list</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.5-P4 (Extended Support Version)</p>
</body>
</html>