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