pkcs11-destroy.docbook revision 1753d3c4d74241a847794f7e7cfd94cc79be6600
2816N/A<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2816N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
2816N/A [<!ENTITY mdash "&#8212;">]>
2816N/A<!--
2816N/A - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
2816N/A -
2816N/A - Permission to use, copy, modify, and/or distribute this software for any
2816N/A - purpose with or without fee is hereby granted, provided that the above
2816N/A - copyright notice and this permission notice appear in all copies.
2816N/A -
2816N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2816N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2816N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2816N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2816N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2816N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2816N/A - PERFORMANCE OF THIS SOFTWARE.
2816N/A-->
2816N/A
2816N/A<refentry id="man.pkcs11-destroy">
2816N/A <refentryinfo>
2816N/A <date>January 15, 2014</date>
2816N/A </refentryinfo>
2816N/A
2816N/A <refmeta>
2816N/A <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
2816N/A <manvolnum>8</manvolnum>
2816N/A <refmiscinfo>BIND9</refmiscinfo>
2816N/A </refmeta>
2816N/A
2816N/A <refnamediv>
2816N/A <refname><application>pkcs11-destroy</application></refname>
2816N/A <refpurpose>destroy PKCS#11 objects</refpurpose>
2816N/A </refnamediv>
2816N/A
2816N/A <docinfo>
2816N/A <copyright>
2816N/A <year>2009</year>
2816N/A <year>2014</year>
2816N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
2816N/A </copyright>
2816N/A </docinfo>
2816N/A
2816N/A <refsynopsisdiv>
2816N/A <cmdsynopsis>
2816N/A <command>pkcs11-destroy</command>
2816N/A <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
2816N/A <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
2816N/A <group choice="req">
2816N/A <arg choice="plain">-i <replaceable class="parameter">ID</replaceable></arg>
2816N/A <arg choice="plain">-l <replaceable class="parameter">label</replaceable></arg>
2816N/A </group>
2816N/A <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
2816N/A <arg><option>-w <replaceable class="parameter">seconds</replaceable></option></arg>
2816N/A </cmdsynopsis>
2816N/A </refsynopsisdiv>
2816N/A
2816N/A <refsect1>
2816N/A <title>DESCRIPTION</title>
2816N/A <para>
2816N/A <command>pkcs11-destroy</command> destroys keys stored in a
2816N/A PKCS#11 device, identified by their <option>ID</option> or
2816N/A <option>label</option>.
2816N/A </para>
2816N/A <para>
2816N/A Matching keys are displayed before being destroyed. By default,
2816N/A there is a five second delay to allow the user to interrupt the
2816N/A process before the destruction takes place.
2816N/A </para>
2816N/A </refsect1>
2816N/A
2816N/A <refsect1>
2816N/A <title>ARGUMENTS</title>
2816N/A <variablelist>
2816N/A <varlistentry>
2816N/A <term>-m <replaceable class="parameter">module</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Specify the PKCS#11 provider module. This must be the full
2816N/A path to a shared library object implementing the PKCS#11 API
2816N/A for the device.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
2816N/A
2816N/A <varlistentry>
2816N/A <term>-s <replaceable class="parameter">slot</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Open the session with the given PKCS#11 slot. The default is
2816N/A slot 0.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
2816N/A
2816N/A <varlistentry>
2816N/A <term>-i <replaceable class="parameter">ID</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Destroy keys with the given object ID.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
2816N/A
2816N/A <varlistentry>
2816N/A <term>-l <replaceable class="parameter">label</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Destroy keys with the given label.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
2816N/A
2816N/A <varlistentry>
2816N/A <term>-p <replaceable class="parameter">PIN</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Specify the PIN for the device. If no PIN is provided on the
2816N/A command line, <command>pkcs11-destroy</command> will prompt for it.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
2816N/A
2816N/A <varlistentry>
2816N/A <term>-w <replaceable class="parameter">seconds</replaceable></term>
2816N/A <listitem>
2816N/A <para>
2816N/A Specify how long to pause before carrying out key destruction.
2816N/A The default is five seconds. If set to <literal>0</literal>,
2816N/A destruction will be immediate.
2816N/A </para>
2816N/A </listitem>
2816N/A </varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pkcs11-list</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->