pkcs11-destroy.html revision 33d0a7767d53cb366039fd0ac4f63cf8a9c351b0
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<!--
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits -
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - Permission to use, copy, modify, and/or distribute this software for any
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - purpose with or without fee is hereby granted, provided that the above
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - copyright notice and this permission notice appear in all copies.
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits -
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits - PERFORMANCE OF THIS SOFTWARE.
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits-->
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<html>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<head>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<title>pkcs11-destroy</title>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits</head>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<div class="refnamediv">
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<h2>Name</h2>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<p><span class="application">pkcs11-destroy</span> &#8212; destroy PKCS#11 objects</p>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits</div>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<div class="refsynopsisdiv">
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<h2>Synopsis</h2>
4ebb14b236958cfe1ef4ff3b7a50216d9e51f997frits<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.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.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.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></body>
</html>