external/bsd/bind/dist/bin/pkcs11/pkcs11-destroy.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2009, 2014  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <refentry id="man.pkcs11-destroy">
  21   <refentryinfo>
  22     <date>January 15, 2014</date>
  23   </refentryinfo>
  24
  25   <refmeta>
  26     <refentrytitle><application>pkcs11-destroy</application></refentrytitle>
  27     <manvolnum>8</manvolnum>
  28     <refmiscinfo>BIND9</refmiscinfo>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname><application>pkcs11-destroy</application></refname>
  33     <refpurpose>destroy PKCS#11 objects</refpurpose>
  34   </refnamediv>
  35
  36   <docinfo>
  37     <copyright>
  38       <year>2009</year>
  39       <year>2014</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42   </docinfo>
  43
  44   <refsynopsisdiv>
  45     <cmdsynopsis>
  46       <command>pkcs11-destroy</command>
  47       <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
  48       <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
  49       <group choice="req">
  50         <arg choice="plain">-i <replaceable class="parameter">ID</replaceable></arg>
  51         <arg choice="plain">-l <replaceable class="parameter">label</replaceable></arg>
  52       </group>
  53       <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
  54       <arg><option>-w <replaceable class="parameter">seconds</replaceable></option></arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>DESCRIPTION</title>
  60     <para>
  61       <command>pkcs11-destroy</command> destroys keys stored in a
  62       PKCS#11 device, identified by their <option>ID</option> or
  63       <option>label</option>.
  64     </para>
  65     <para>
  66       Matching keys are displayed before being destroyed.  By default,
  67       there is a five second delay to allow the user to interrupt the
  68       process before the destruction takes place.
  69     </para>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>ARGUMENTS</title>
  74     <variablelist>
  75       <varlistentry>
  76         <term>-m <replaceable class="parameter">module</replaceable></term>
  77         <listitem>
  78           <para>
  79             Specify the PKCS#11 provider module.  This must be the full
  80             path to a shared library object implementing the PKCS#11 API
  81             for the device.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term>-s <replaceable class="parameter">slot</replaceable></term>
  88         <listitem>
  89           <para>
  90             Open the session with the given PKCS#11 slot.  The default is
  91             slot 0.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term>-i <replaceable class="parameter">ID</replaceable></term>
  98         <listitem>
  99           <para>
 100             Destroy keys with the given object ID.
 101           </para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term>-l <replaceable class="parameter">label</replaceable></term>
 107         <listitem>
 108           <para>
 109             Destroy keys with the given label.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>-p <replaceable class="parameter">PIN</replaceable></term>
 116         <listitem>
 117           <para>
 118             Specify the PIN for the device.  If no PIN is provided on the
 119             command line, <command>pkcs11-destroy</command> will prompt for it.
 120           </para>
 121         </listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term>-w <replaceable class="parameter">seconds</replaceable></term>
 126         <listitem>
 127           <para>
 128             Specify how long to pause before carrying out key destruction.
 129             The default is five seconds.  If set to <literal>0</literal>,
 130             destruction will be immediate.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </refsect1>
 136
 137   <refsect1>
 138     <title>SEE ALSO</title>
 139     <para>
 140       <citerefentry>
 141         <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
 142       </citerefentry>,
 143       <citerefentry>
 144         <refentrytitle>pkcs11-list</refentrytitle><manvolnum>8</manvolnum>
 145       </citerefentry>,
 146       <citerefentry>
 147         <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
 148       </citerefentry>
 149     </para>
 150   </refsect1>
 151
 152   <refsect1>
 153     <title>AUTHOR</title>
 154     <para><corpauthor>Internet Systems Consortium</corpauthor>
 155     </para>
 156   </refsect1>
 157
 158 </refentry><!--
 159  - Local variables:
 160  - mode: sgml
 161  - End:
 162 -->