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