pkcs11-destroy.html revision 1.1.1.2.6.1
1<!--
2 - Copyright (C) 2009  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
17<!-- Id: pkcs11-destroy.html,v 1.3 2009/10/06 04:40:14 tbox Exp  -->
18<html>
19<head>
20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21<title>pkcs11-destroy</title>
22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23</head>
24<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
26<div class="refnamediv">
27<h2>Name</h2>
28<p><span class="application">pkcs11-destroy</span> &#8212; destroy PKCS#11 objects</p>
29</div>
30<div class="refsynopsisdiv">
31<h2>Synopsis</h2>
32<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>]</p></div>
33</div>
34<div class="refsect1" lang="en">
35<a name="id2543384"></a><h2>DESCRIPTION</h2>
36<p>
37      <span><strong class="command">pkcs11-destroy</strong></span> destroys keys stored in a
38      PKCS#11 device, identified by their <code class="option">ID</code> or
39      <code class="option">label</code>.
40    </p>
41<p>
42      Matching keys are displayed before being destroyed.  There is a
43      five second delay to allow the user to interrupt the process
44      before the destruction takes place.
45    </p>
46</div>
47<div class="refsect1" lang="en">
48<a name="id2543406"></a><h2>ARGUMENTS</h2>
49<div class="variablelist"><dl>
50<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
51<dd><p>
52            Specify the PKCS#11 provider module.  This must be the full
53            path to a shared library object implementing the PKCS#11 API
54            for the device.
55          </p></dd>
56<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
57<dd><p>
58            Open the session with the given PKCS#11 slot.  The default is
59            slot 0.
60          </p></dd>
61<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
62<dd><p>
63            Destroy keys with the given object ID.
64          </p></dd>
65<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
66<dd><p>
67            Destroy keys with the given label.
68          </p></dd>
69<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
70<dd><p>
71            Specify the PIN for the device.  If no PIN is provided on the
72            command line, <span><strong class="command">pkcs11-destroy</strong></span> will prompt for it.
73          </p></dd>
74</dl></div>
75</div>
76<div class="refsect1" lang="en">
77<a name="id2543507"></a><h2>SEE ALSO</h2>
78<p>
79      <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(3)</span>,
80      <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(3)</span>
81    </p>
82</div>
83<div class="refsect1" lang="en">
84<a name="id2543533"></a><h2>AUTHOR</h2>
85<p><span class="corpauthor">Internet Systems Consortium</span>
86    </p>
87</div>
88</div></body>
89</html>
90