pkcs11-list.docbook revision f1a2709aad7baa4161fdb6f63edf99b0150af252
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - purpose with or without fee is hereby granted, provided that the above
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - copyright notice and this permission notice appear in all copies.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - 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
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein - PERFORMANCE OF THIS SOFTWARE.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<!-- Converted by db4-upgrade version 1.0 -->
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentryinfo>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refentryinfo>
194e2dfffa6a167b8eef0ad11864026b423a1c30Mark Andrews <refentrytitle><application>pkcs11-list</application></refentrytitle>
19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User <refname><application>pkcs11-list</application></refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg choice="opt" rep="norepeat"><option>-P</option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </cmdsynopsis>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refsection><info><title>DESCRIPTION</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein lists the PKCS#11 objects with <option>ID</option> or
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>label</option> or by default all objects.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The object class, label, and ID are displayed for all
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson keys. For private or secret keys, the extractability
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein attribute is also displayed, as either <literal>true</literal>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <literal>false</literal>, or <literal>never</literal>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsection>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refsection><info><title>ARGUMENTS</title></info>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson <variablelist>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein List only the public objects. (Note that on some PKCS#11
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein devices, all objects are private.)
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-m <replaceable class="parameter">module</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specify the PKCS#11 provider module. This must be the full
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein path to a shared library object implementing the PKCS#11 API
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson for the device.
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </varlistentry>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-s <replaceable class="parameter">slot</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Open the session with the given PKCS#11 slot. The default is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-i <replaceable class="parameter">ID</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein List only key objects with the given object ID.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-l <replaceable class="parameter">label</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein List only key objects with the given label.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term>-p <replaceable class="parameter">PIN</replaceable></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specify the PIN for the device. If no PIN is provided on the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein command line, <command>pkcs11-list</command> will prompt for it.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsection>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsection><info><title>SEE ALSO</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsection>