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