pkcs11-destroy.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - Permission to use, copy, modify, and/or distribute this software for any
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - purpose with or without fee is hereby granted, provided that the above
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - copyright notice and this permission notice appear in all copies.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap - PERFORMANCE OF THIS SOFTWARE.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap<!-- Converted by db4-upgrade version 1.0 -->
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-destroy">
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refentryinfo>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </refentryinfo>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refnamediv>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refname><application>pkcs11-destroy</application></refname>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refpurpose>destroy PKCS#11 objects</refpurpose>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </refnamediv>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
d4b0f84707225327c617c6838361d3cfb7762b34Jack Meng </copyright>
d4b0f84707225327c617c6838361d3cfb7762b34Jack Meng <refsynopsisdiv>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="plain" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="plain" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <arg choice="opt" rep="norepeat"><option>-w <replaceable class="parameter">seconds</replaceable></option></arg>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </cmdsynopsis>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </refsynopsisdiv>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refsection><info><title>DESCRIPTION</title></info>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <command>pkcs11-destroy</command> destroys keys stored in a
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap PKCS#11 device, identified by their <option>ID</option> or
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Matching keys are displayed before being destroyed. By default,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap there is a five second delay to allow the user to interrupt the
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap process before the destruction takes place.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </refsection>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refsection><info><title>ARGUMENTS</title></info>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <variablelist>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-m <replaceable class="parameter">module</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Specify the PKCS#11 provider module. This must be the full
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap path to a shared library object implementing the PKCS#11 API
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap for the device.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </varlistentry>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-s <replaceable class="parameter">slot</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Open the session with the given PKCS#11 slot. The default is
a668b114487acbb725f522170849c39f8e844673Priya Krishnan </varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-i <replaceable class="parameter">ID</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Destroy keys with the given object ID.
30e7468f8f41aa30ada067b2c1d5d284046514daPeter Dunlap </varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-l <replaceable class="parameter">label</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Destroy keys with the given label.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-p <replaceable class="parameter">PIN</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Specify the PIN for the device. If no PIN is provided on the
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap command line, <command>pkcs11-destroy</command> will prompt for it.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <term>-w <replaceable class="parameter">seconds</replaceable></term>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap Specify how long to pause before carrying out key destruction.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap The default is five seconds. If set to <literal>0</literal>,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap destruction will be immediate.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </varlistentry>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </variablelist>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap </refsection>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <refsection><info><title>SEE ALSO</title></info>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan <citerefentry>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan </citerefentry>,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <citerefentry>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan <refentrytitle>pkcs11-list</refentrytitle><manvolnum>8</manvolnum>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan </citerefentry>,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap <citerefentry>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan </citerefentry>
a668b114487acbb725f522170849c39f8e844673Priya Krishnan </refsection>