1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3	       [<!ENTITY mdash "&#8212;">]>
4<!--
5 - Copyright (C) 2009  Internet Systems Consortium, Inc. ("ISC")
6 -
7 - Permission to use, copy, modify, and/or distribute this software for any
8 - purpose with or without fee is hereby granted, provided that the above
9 - copyright notice and this permission notice appear in all copies.
10 -
11 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 - PERFORMANCE OF THIS SOFTWARE.
18-->
19
20<!-- $Id: pkcs11-destroy.docbook,v 1.2 2009/10/05 12:07:08 fdupont Exp $ -->
21<refentry id="man.pkcs11-destroy">
22  <refentryinfo>
23    <date>Sep 18, 2009</date>
24  </refentryinfo>
25
26  <refmeta>
27    <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
28    <manvolnum>8</manvolnum>
29    <refmiscinfo>BIND9</refmiscinfo>
30  </refmeta>
31
32  <refnamediv>
33    <refname><application>pkcs11-destroy</application></refname>
34    <refpurpose>destroy PKCS#11 objects</refpurpose>
35  </refnamediv>
36
37  <docinfo>
38    <copyright>
39      <year>2009</year>
40      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
41    </copyright>
42  </docinfo>
43
44  <refsynopsisdiv>
45    <cmdsynopsis>
46      <command>pkcs11-destroy</command>
47      <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
48      <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
49      <group choice="req">
50        <arg choice="plain">-i <replaceable class="parameter">ID</replaceable></arg>
51        <arg choice="plain">-l <replaceable class="parameter">label</replaceable></arg>
52      </group>
53      <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
54    </cmdsynopsis>
55  </refsynopsisdiv>
56
57  <refsect1>
58    <title>DESCRIPTION</title>
59    <para>
60      <command>pkcs11-destroy</command> destroys keys stored in a
61      PKCS#11 device, identified by their <option>ID</option> or
62      <option>label</option>.
63    </para>
64    <para>
65      Matching keys are displayed before being destroyed.  There is a
66      five second delay to allow the user to interrupt the process
67      before the destruction takes place.
68    </para>
69  </refsect1>
70
71  <refsect1>
72    <title>ARGUMENTS</title>
73    <variablelist>
74      <varlistentry>
75        <term>-m <replaceable class="parameter">module</replaceable></term>
76        <listitem>
77          <para>
78            Specify the PKCS#11 provider module.  This must be the full
79            path to a shared library object implementing the PKCS#11 API
80            for the device.
81          </para>
82        </listitem>
83      </varlistentry>
84
85      <varlistentry>
86        <term>-s <replaceable class="parameter">slot</replaceable></term>
87        <listitem>
88          <para>
89            Open the session with the given PKCS#11 slot.  The default is
90            slot 0.
91          </para>
92        </listitem>
93      </varlistentry>
94
95      <varlistentry>
96        <term>-i <replaceable class="parameter">ID</replaceable></term>
97        <listitem>
98          <para>
99            Destroy keys with the given object ID.
100          </para>
101        </listitem>
102      </varlistentry>
103
104      <varlistentry>
105        <term>-l <replaceable class="parameter">label</replaceable></term>
106        <listitem>
107          <para>
108            Destroy keys with the given label.
109          </para>
110        </listitem>
111      </varlistentry>
112
113      <varlistentry>
114        <term>-p <replaceable class="parameter">PIN</replaceable></term>
115        <listitem>
116          <para>
117            Specify the PIN for the device.  If no PIN is provided on the
118            command line, <command>pkcs11-destroy</command> will prompt for it.
119          </para>
120        </listitem>
121      </varlistentry>
122    </variablelist>
123  </refsect1>
124
125  <refsect1>
126    <title>SEE ALSO</title>
127    <para>
128      <citerefentry>
129        <refentrytitle>pkcs11-list</refentrytitle><manvolnum>3</manvolnum>
130      </citerefentry>,
131      <citerefentry>
132        <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>3</manvolnum>
133      </citerefentry>
134    </para>
135  </refsect1>
136
137  <refsect1>
138    <title>AUTHOR</title>
139    <para><corpauthor>Internet Systems Consortium</corpauthor>
140    </para>
141  </refsect1>
142
143</refentry><!--
144 - Local variables:
145 - mode: sgml
146 - End:
147-->
148