pkcs11-list.docbook revision 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b
e375fc9ca73b53e07edaf5f1fa81592365549a5dChristian Maeder<!--
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl -
a530dde7009b0a808300c420def741354a4d13d2Martin Kühl - Permission to use, copy, modify, and/or distribute this software for any
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl - purpose with or without fee is hereby granted, provided that the above
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu - copyright notice and this permission notice appear in all copies.
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl -
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl - PERFORMANCE OF THIS SOFTWARE.
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl-->
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl<!-- Converted by db4-upgrade version 1.0 -->
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <info>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <date>2009-10-05</date>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </info>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <refentryinfo>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <corpname>ISC</corpname>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </refentryinfo>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refmeta>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <refentrytitle><application>pkcs11-list</application></refentrytitle>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <manvolnum>8</manvolnum>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refmiscinfo>BIND9</refmiscinfo>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </refmeta>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refnamediv>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refname><application>pkcs11-list</application></refname>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refpurpose>list PKCS#11 objects</refpurpose>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </refnamediv>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <docinfo>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <copyright>
0e9a56585859610db38a1f900d87ee8680ced4d0Martin Kühl <year>2009</year>
0e9a56585859610db38a1f900d87ee8680ced4d0Martin Kühl <year>2014</year>
0e9a56585859610db38a1f900d87ee8680ced4d0Martin Kühl <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco </copyright>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco </docinfo>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl <refsynopsisdiv>
3f9cd04710597ee787032a371f33861640ab2abeAdrián Riesco <cmdsynopsis sepchar=" ">
521e1648b2c66064c41e9ac47bcd510356ed2355Adrián Riesco <command>pkcs11-list</command>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <arg choice="opt" rep="norepeat"><option>-P</option></arg>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <arg choice="opt" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <arg choice="opt" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
521e1648b2c66064c41e9ac47bcd510356ed2355Adrián Riesco <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
3f9cd04710597ee787032a371f33861640ab2abeAdrián Riesco </cmdsynopsis>
c71a28752b8269572ba1de2e2230bb97a4dde6eaMartin Kühl </refsynopsisdiv>
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl
6858f9c9c8b077b2b574a9f30753cf5fec8124d6Martin Kühl <refsection><info><title>DESCRIPTION</title></info>
c71a28752b8269572ba1de2e2230bb97a4dde6eaMartin Kühl
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl <para>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco <command>pkcs11-list</command>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl lists the PKCS#11 objects with <option>ID</option> or
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <option>label</option> or by default all objects.
e368ae35ce99348be3de4181acd7a6f4ce03fe0cChristian Maeder </para>
d414874e167a775b151450f9fd340a6015d9bbe7Martin Kühl </refsection>
b92e4eba198fcbffab302375b6c3527a8492bc66Adrián Riesco
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refsection><info><title>ARGUMENTS</title></info>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <variablelist>
6858f9c9c8b077b2b574a9f30753cf5fec8124d6Martin Kühl <varlistentry>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <term>-P</term>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco <listitem>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <para>
973f776b7e2729a4d87a4f2a657d037129b6d700Martin Kühl List only the public objects. (Note that on some PKCS#11
973f776b7e2729a4d87a4f2a657d037129b6d700Martin Kühl devices, all objects are private.)
b22baa863f0a8bd4ac32a3e5fa7b476fc5aa78fdMartin Kühl </para>
93da827a79b9d7122ed9bb5636a62bae43565b21Adrián Riesco </listitem>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </varlistentry>
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <varlistentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <term>-m <replaceable class="parameter">module</replaceable></term>
18328fcbfe4296582227d42fdcf363f5a0fb8921Martin Kühl <listitem>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <para>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco Specify the PKCS#11 provider module. This must be the full
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl path to a shared library object implementing the PKCS#11 API
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl for the device.
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </para>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </listitem>
b92e4eba198fcbffab302375b6c3527a8492bc66Adrián Riesco </varlistentry>
b92e4eba198fcbffab302375b6c3527a8492bc66Adrián Riesco
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <varlistentry>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl <term>-s <replaceable class="parameter">slot</replaceable></term>
b92e4eba198fcbffab302375b6c3527a8492bc66Adrián Riesco <listitem>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl <para>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl Open the session with the given PKCS#11 slot. The default is
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl slot 0.
e368ae35ce99348be3de4181acd7a6f4ce03fe0cChristian Maeder </para>
e368ae35ce99348be3de4181acd7a6f4ce03fe0cChristian Maeder </listitem>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco </varlistentry>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco <varlistentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <term>-i <replaceable class="parameter">ID</replaceable></term>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <listitem>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <para>
a0d0f20cd1636b14a0382c4820e99856fd9ed6a1Christian Maeder List only key objects with the given object ID.
a74f814d3b445eadad6f68737a98a7a303698affChristian Maeder </para>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </listitem>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl </varlistentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <varlistentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <term>-l <replaceable class="parameter">label</replaceable></term>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <listitem>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <para>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco List only key objects with the given label.
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl </para>
c6a4f949f2a9da476c80399fb061020937255f87Adrián Riesco </listitem>
c6a4f949f2a9da476c80399fb061020937255f87Adrián Riesco </varlistentry>
c6a4f949f2a9da476c80399fb061020937255f87Adrián Riesco
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <varlistentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <term>-p <replaceable class="parameter">PIN</replaceable></term>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl <listitem>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl <para>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl Specify the PIN for the device. If no PIN is provided on the
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl command line, <command>pkcs11-list</command> will prompt for it.
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </para>
6f6549c13f912de12345850e4eb248ec358c1b43Adrián Riesco </listitem>
50f20e59ae4e2eade016bce32b6aa609a7320f92Martin Kühl </varlistentry>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </variablelist>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </refsection>
e37cb7bdd94eb318ed94100be0083bf96f5ad58dMartin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refsection><info><title>SEE ALSO</title></info>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl <para>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco <citerefentry>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco </citerefentry>,
6d498b6f56ed9f71cced898b6c42fb48f6e60583Adrián Riesco <citerefentry>
70bd0fbf318b8bb489b20fe8197469afc55dddb5Martin Kühl <refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
2f6481f1527d705d769b74357c19ac085aaeefcbMartin Kühl </citerefentry>,
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <citerefentry>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </citerefentry>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl </para>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl </refsection>
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl
3c8734f5b76d06ed1eae114c67e77066acb6a40bMartin Kühl</refentry>
8d9ff304e4ec23e883f4ed22b95e054d80c7fd70Martin Kühl