bin/pkcs11/pkcs11-destroy.html

	pkcs11-destroy.html revision 7911e6f9de303bca5a3d8b34f4330c8f7cecffae
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!--
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe -
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - This Source Code Form is subject to the terms of the Mozilla Public
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - License, v. 2.0. If a copy of the MPL was not distributed with this
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - file, You can obtain one at http://mozilla.org/MPL/2.0/.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe-->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<html lang="en">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<head>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<title>pkcs11-destroy</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</head>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<a name="man.pkcs11-destroy"></a><div class="titlepage"></div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe  <div class="refnamediv">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<h2>Name</h2>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe    <span class="application">pkcs11-destroy</span>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe     &#8212; destroy PKCS#11 objects
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov  </p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov


  <div class="refsynopsisdiv">
<h2>Synopsis</h2>
    <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>