pkcs11-destroy.html revision 33d0a7767d53cb366039fd0ac4f63cf8a9c351b0
1N/A<!--
1N/A - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
1N/A -
1N/A - Permission to use, copy, modify, and/or distribute this software for any
1N/A - purpose with or without fee is hereby granted, provided that the above
1N/A - copyright notice and this permission notice appear in all copies.
1N/A -
1N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
1N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
1N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1N/A - PERFORMANCE OF THIS SOFTWARE.
1N/A-->
1N/A<html>
1N/A<head>
1N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1N/A<title>pkcs11-destroy</title>
1N/A<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
1N/A</head>
1N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
1N/A<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
1N/A<div class="refnamediv">
1N/A<h2>Name</h2>
1N/A<p><span class="application">pkcs11-destroy</span> &#8212; destroy PKCS#11 objects</p>
1N/A</div>
1N/A<div class="refsynopsisdiv">
1N/A<h2>Synopsis</h2>
1N/A<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>
1N/A</div>
1N/A<div class="refsection">
1N/A<a name="id-1.7"></a><h2>DESCRIPTION</h2>
1N/A<p>
1N/A <span class="command"><strong>pkcs11-destroy</strong></span> destroys keys stored in a
1N/A PKCS#11 device, identified by their <code class="option">ID</code> or
1N/A <code class="option">label</code>.
1N/A </p>
1N/A<p>
1N/A Matching keys are displayed before being destroyed. By default,
1N/A there is a five second delay to allow the user to interrupt the
1N/A process before the destruction takes place.
1N/A </p>
1N/A</div>
1N/A<div class="refsection">
1N/A<a name="id-1.8"></a><h2>ARGUMENTS</h2>
1N/A<div class="variablelist"><dl class="variablelist">
1N/A<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
1N/A<dd><p>
1N/A Specify the PKCS#11 provider module. This must be the full
1N/A path to a shared library object implementing the PKCS#11 API
1N/A for the device.
1N/A </p></dd>
1N/A<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
1N/A<dd><p>
1N/A Open the session with the given PKCS#11 slot. The default is
1N/A slot 0.
1N/A </p></dd>
1N/A<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
1N/A<dd><p>
1N/A Destroy keys with the given object ID.
1N/A </p></dd>
1N/A<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
1N/A<dd><p>
1N/A Destroy keys with the given label.
1N/A </p></dd>
1N/A<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
1N/A<dd><p>
1N/A Specify the PIN for the device. If no PIN is provided on the
1N/A command line, <span class="command"><strong>pkcs11-destroy</strong></span> will prompt for it.
1N/A </p></dd>
1N/A<dt><span class="term">-w <em class="replaceable"><code>seconds</code></em></span></dt>
1N/A<dd><p>
1N/A Specify how long to pause before carrying out key destruction.
1N/A The default is five seconds. If set to <code class="literal">0</code>,
1N/A destruction will be immediate.
1N/A </p></dd>
1N/A</dl></div>
1N/A</div>
1N/A<div class="refsection">
1N/A<a name="id-1.9"></a><h2>SEE ALSO</h2>
1N/A<p>
1N/A <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(8)</span>,
1N/A <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(8)</span>,
1N/A <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>
1N/A </p>
1N/A</div>
1N/A</div></body>
1N/A</html>
1N/A