pkcs11-destroy.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<!--
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
bef75d63d74f58abc0f834ed271526672777ba29Automatic Updater -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater -
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User - PERFORMANCE OF THIS SOFTWARE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt-->
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User<!-- Converted by db4-upgrade version 1.0 -->
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-destroy">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <info>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <date>2014-01-15</date>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </info>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refentryinfo>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <corpname>ISC</corpname>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refentryinfo>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refmeta>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <manvolnum>8</manvolnum>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refmiscinfo>BIND9</refmiscinfo>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refmeta>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refnamediv>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refname><application>pkcs11-destroy</application></refname>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refpurpose>destroy PKCS#11 objects</refpurpose>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refnamediv>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <docinfo>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <copyright>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <year>2009</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <year>2014</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </copyright>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </docinfo>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsynopsisdiv>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <cmdsynopsis sepchar=" ">
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User <command>pkcs11-destroy</command>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User <group choice="req" rep="norepeat">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <arg choice="plain" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="plain" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </group>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <arg choice="opt" rep="norepeat"><option>-w <replaceable class="parameter">seconds</replaceable></option></arg>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </cmdsynopsis>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refsynopsisdiv>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refsection><info><title>DESCRIPTION</title></info>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <para>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <command>pkcs11-destroy</command> destroys keys stored in a
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater PKCS#11 device, identified by their <option>ID</option> or
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>label</option>.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Matching keys are displayed before being destroyed. By default,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User there is a five second delay to allow the user to interrupt the
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User process before the destruction takes place.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </refsection>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refsection><info><title>ARGUMENTS</title></info>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <variablelist>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <varlistentry>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <term>-m <replaceable class="parameter">module</replaceable></term>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <listitem>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater Specify the PKCS#11 provider module. This must be the full
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater path to a shared library object implementing the PKCS#11 API
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt for the device.
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User </para>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </listitem>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </varlistentry>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <varlistentry>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <term>-s <replaceable class="parameter">slot</replaceable></term>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <listitem>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User Open the session with the given PKCS#11 slot. The default is
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater slot 0.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </listitem>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </varlistentry>
5f0c46ca5f68c2148c735aa52d7541baac249c34Tinderbox User
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <varlistentry>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <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>