pkcs11-destroy.docbook revision ba751492fcc4f161a18b983d4f018a1a52938cb9
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt [<!ENTITY mdash "—">]>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - Permission to use, copy, modify, and/or distribute this software for any
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - purpose with or without fee is hereby granted, provided that the above
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - copyright notice and this permission notice appear in all copies.
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
821350367e2c7313c02eb275e8e05d5193b47cfdJeremy C. Reed - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt - PERFORMANCE OF THIS SOFTWARE.
2637d30fbd235fe98145f4312b10cc41a13bf7dcJeremy C. Reed<!-- $Id: pkcs11-destroy.docbook,v 1.2 2009/10/05 12:07:08 fdupont Exp $ -->
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refentryinfo>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </refentryinfo>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refnamediv>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refname><application>pkcs11-destroy</application></refname>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </refnamediv>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </copyright>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refsynopsisdiv>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <cmdsynopsis>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews <arg choice="plain">-i <replaceable class="parameter">ID</replaceable></arg>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <arg choice="plain">-l <replaceable class="parameter">label</replaceable></arg>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <arg><option>-w <replaceable class="parameter">seconds</replaceable></option></arg>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </cmdsynopsis>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </refsynopsisdiv>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <command>pkcs11-destroy</command> destroys keys stored in a
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt PKCS#11 device, identified by their <option>ID</option> or
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Matching keys are displayed before being destroyed. By default,
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt there is a five second delay to allow the user to interrupt the
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt process before the destruction takes place.
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt <variablelist>
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt <varlistentry>
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt <term>-m <replaceable class="parameter">module</replaceable></term>
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt Specify the PKCS#11 provider module. This must be the full
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt path to a shared library object implementing the PKCS#11 API
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt for the device.
3e7aa395774dfb23fe36a30a70b13624487d37b8Evan Hunt </varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <term>-s <replaceable class="parameter">slot</replaceable></term>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Open the session with the given PKCS#11 slot. The default is
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <term>-i <replaceable class="parameter">ID</replaceable></term>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Destroy keys with the given object ID.
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <term>-l <replaceable class="parameter">label</replaceable></term>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Destroy keys with the given label.
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <term>-p <replaceable class="parameter">PIN</replaceable></term>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Specify the PIN for the device. If no PIN is provided on the
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt command line, <command>pkcs11-destroy</command> will prompt for it.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <term>-w <replaceable class="parameter">seconds</replaceable></term>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt Specify how long to pause before carrying out key destruction.
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt The default is five seconds. If set to <literal>0</literal>,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt destruction will be immediate.
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </varlistentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </variablelist>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <citerefentry>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <refentrytitle>pkcs11-list</refentrytitle><manvolnum>3</manvolnum>
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt </citerefentry>,
2b8bed6681d1541474f022586cbe728dfce36880Evan Hunt <citerefentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>3</manvolnum>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </citerefentry>