pkcs11-destroy.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<!--
6736c640e65e06990ef33af71ee81fac4df4ff5fjim - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
6736c640e65e06990ef33af71ee81fac4df4ff5fjim -
6736c640e65e06990ef33af71ee81fac4df4ff5fjim - This Source Code Form is subject to the terms of the Mozilla Public
415bb21f281e9b4f905d5893fede9165bdf1491bjim - License, v. 2.0. If a copy of the MPL was not distributed with this
415bb21f281e9b4f905d5893fede9165bdf1491bjim - file, You can obtain one at http://mozilla.org/MPL/2.0/.
f743002678eb67b99bbc29fee116b65d9530fec0wrowe-->
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<html>
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<head>
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2cd2891cea784de97020bcada4e834e224428d0ccovener<title>pkcs11-destroy</title>
2cd2891cea784de97020bcada4e834e224428d0ccovener<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
2cd2891cea784de97020bcada4e834e224428d0ccovener</head>
2cd2891cea784de97020bcada4e834e224428d0ccovener<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
1f9c3dc1ba4b56b2c14f40db86f532114504b5cfwrowe<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
1f9c3dc1ba4b56b2c14f40db86f532114504b5cfwrowe<div class="refnamediv">
2cd2891cea784de97020bcada4e834e224428d0ccovener<h2>Name</h2>
c60018e9cf43220afed53c8f50f42e71cec7e70esf<p><span class="application">pkcs11-destroy</span> &#8212; destroy PKCS#11 objects</p>
c60018e9cf43220afed53c8f50f42e71cec7e70esf</div>
c60018e9cf43220afed53c8f50f42e71cec7e70esf<div class="refsynopsisdiv">
c60018e9cf43220afed53c8f50f42e71cec7e70esf<h2>Synopsis</h2>
fb333f30ae01a1f14b2afaa8a92c99192abf883erjung<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>
fb333f30ae01a1f14b2afaa8a92c99192abf883erjung</div>
fb333f30ae01a1f14b2afaa8a92c99192abf883erjung<div class="refsection">
69a4ff202d78f0a69cd87cb0edc9964b2db4946csf<a name="id-1.7"></a><h2>DESCRIPTION</h2>
69a4ff202d78f0a69cd87cb0edc9964b2db4946csf<p>
69a4ff202d78f0a69cd87cb0edc9964b2db4946csf <span class="command"><strong>pkcs11-destroy</strong></span> destroys keys stored in a
fec106c7688e279dfde4403bc3c935fec97c1d62sf PKCS#11 device, identified by their <code class="option">ID</code> or
fec106c7688e279dfde4403bc3c935fec97c1d62sf <code class="option">label</code>.
fec106c7688e279dfde4403bc3c935fec97c1d62sf </p>
4872f2c13be21115687dedcdf2515980fde93b70covener<p>
4872f2c13be21115687dedcdf2515980fde93b70covener Matching keys are displayed before being destroyed. By default,
be918ac21416c363014aca09383937579ca01db5covener there is a five second delay to allow the user to interrupt the
be918ac21416c363014aca09383937579ca01db5covener process before the destruction takes place.
be918ac21416c363014aca09383937579ca01db5covener </p>
be918ac21416c363014aca09383937579ca01db5covener</div>
0a2212da6843659e65c378c5201e6612be625731sf<div class="refsection">
0a2212da6843659e65c378c5201e6612be625731sf<a name="id-1.8"></a><h2>ARGUMENTS</h2>
0a2212da6843659e65c378c5201e6612be625731sf<div class="variablelist"><dl class="variablelist">
0a2212da6843659e65c378c5201e6612be625731sf<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
0a2212da6843659e65c378c5201e6612be625731sf<dd><p>
789f46cb4d4c3e32f6550f17f74ea4a054095901covener Specify the PKCS#11 provider module. This must be the full
789f46cb4d4c3e32f6550f17f74ea4a054095901covener path to a shared library object implementing the PKCS#11 API
789f46cb4d4c3e32f6550f17f74ea4a054095901covener for the device.
789f46cb4d4c3e32f6550f17f74ea4a054095901covener </p></dd>
789f46cb4d4c3e32f6550f17f74ea4a054095901covener<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
539c658848512631bb4db3529e84b6d45401b925covener<dd><p>
539c658848512631bb4db3529e84b6d45401b925covener Open the session with the given PKCS#11 slot. The default is
539c658848512631bb4db3529e84b6d45401b925covener slot 0.
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf </p></dd>
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf<dd><p>
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf Destroy keys with the given object ID.
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf </p></dd>
c07f5b18040b0d39b077666ad6fbbd28fe0eb5f1sf<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
94bc56b747dda8afb8806d04e08164ea99e4c21dsf<dd><p>
94bc56b747dda8afb8806d04e08164ea99e4c21dsf Destroy keys with the given label.
5fcf1d4211ba64b1e9c7647fcc615a9e850c6c88covener </p></dd>
5fcf1d4211ba64b1e9c7647fcc615a9e850c6c88covener<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
5fcf1d4211ba64b1e9c7647fcc615a9e850c6c88covener<dd><p>
81cc440ca73845f44dc589db106d3feb7a36f33bminfrin Specify the PIN for the device. If no PIN is provided on the
81cc440ca73845f44dc589db106d3feb7a36f33bminfrin command line, <span class="command"><strong>pkcs11-destroy</strong></span> will prompt for it.
81cc440ca73845f44dc589db106d3feb7a36f33bminfrin </p></dd>
65dec0561786621bd67f57e8054dcf80923b6cb1jorton<dt><span class="term">-w <em class="replaceable"><code>seconds</code></em></span></dt>
65dec0561786621bd67f57e8054dcf80923b6cb1jorton<dd><p>
65dec0561786621bd67f57e8054dcf80923b6cb1jorton Specify how long to pause before carrying out key destruction.
cda2a8c4fe289419f62e8b9607cafe4812974840sf The default is five seconds. If set to <code class="literal">0</code>,
cda2a8c4fe289419f62e8b9607cafe4812974840sf destruction will be immediate.
cda2a8c4fe289419f62e8b9607cafe4812974840sf </p></dd>
3bb96836b77f718d914dbcdbe3d9bf3ca22859a5minfrin</dl></div>
3bb96836b77f718d914dbcdbe3d9bf3ca22859a5minfrin</div>
3bb96836b77f718d914dbcdbe3d9bf3ca22859a5minfrin<div class="refsection">
79821ac529d05349274b7ed2421077afffbc0c08sf<a name="id-1.9"></a><h2>SEE ALSO</h2>
79821ac529d05349274b7ed2421077afffbc0c08sf<p>
79821ac529d05349274b7ed2421077afffbc0c08sf <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(8)</span>,
6e3c52ed5ba88bb05d3535c6257a61faeec22388minfrin <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(8)</span>,
6e3c52ed5ba88bb05d3535c6257a61faeec22388minfrin <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>
6e3c52ed5ba88bb05d3535c6257a61faeec22388minfrin </p>
aa8ce00557e35b6042be4afa1684b2322def4520covener</div>
aa8ce00557e35b6042be4afa1684b2322def4520covener</div></body>
aa8ce00557e35b6042be4afa1684b2322def4520covener</html>
b80324fbe463460d1c847b88ffe2132f92ce5587sf