external/bsd/bind/dist/bin/pkcs11/pkcs11-list.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-list">
  21   <refentryinfo>
  22     <date>October 05, 2009</date>
  23   </refentryinfo>
  24
  25   <refmeta>
  26     <refentrytitle><application>pkcs11-list</application></refentrytitle>
  27     <manvolnum>8</manvolnum>
  28     <refmiscinfo>BIND9</refmiscinfo>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname><application>pkcs11-list</application></refname>
  33     <refpurpose>list 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-list</command>
  47       <arg><option>-P</option></arg>
  48       <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
  49       <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
  50       <arg choice="opt">-i <replaceable class="parameter">ID</replaceable></arg>
  51       <arg choice="opt">-l <replaceable class="parameter">label</replaceable></arg>
  52       <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
  53     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>DESCRIPTION</title>
  58     <para>
  59       <command>pkcs11-list</command>
  60       lists the PKCS#11 objects with <option>ID</option> or
  61       <option>label</option> or by default all objects.
  62     </para>
  63   </refsect1>
  64
  65   <refsect1>
  66     <title>ARGUMENTS</title>
  67     <variablelist>
  68       <varlistentry>
  69         <term>-P</term>
  70         <listitem>
  71           <para>
  72             List only the public objects. (Note that on some PKCS#11
  73             devices, all objects are private.)
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term>-m <replaceable class="parameter">module</replaceable></term>
  80         <listitem>
  81           <para>
  82             Specify the PKCS#11 provider module.  This must be the full
  83             path to a shared library object implementing the PKCS#11 API
  84             for the device.
  85           </para>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term>-s <replaceable class="parameter">slot</replaceable></term>
  91         <listitem>
  92           <para>
  93             Open the session with the given PKCS#11 slot.  The default is
  94             slot 0.
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term>-i <replaceable class="parameter">ID</replaceable></term>
 101         <listitem>
 102           <para>
 103             List only key objects with the given object ID.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>-l <replaceable class="parameter">label</replaceable></term>
 110         <listitem>
 111           <para>
 112             List only key objects with the given label.
 113           </para>
 114         </listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term>-p <replaceable class="parameter">PIN</replaceable></term>
 119         <listitem>
 120           <para>
 121             Specify the PIN for the device.  If no PIN is provided on the
 122             command line, <command>pkcs11-list</command> will prompt for it.
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126     </variablelist>
 127   </refsect1>
 128
 129   <refsect1>
 130     <title>SEE ALSO</title>
 131     <para>
 132       <citerefentry>
 133         <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
 134       </citerefentry>,
 135       <citerefentry>
 136         <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
 137       </citerefentry>,
 138       <citerefentry>
 139         <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
 140       </citerefentry>
 141     </para>
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>AUTHOR</title>
 146     <para><corpauthor>Internet Systems Consortium</corpauthor>
 147     </para>
 148   </refsect1>
 149
 150 </refentry><!--
 151  - Local variables:
 152  - mode: sgml
 153  - End:
 154 -->