external/bsd/bind/dist/bin/pkcs11/pkcs11-destroy.html

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