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