pkcs11-list.docbook revision 83a28ca274521e15086fc39febde507bcc4e145e
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!--
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw -
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - This Source Code Form is subject to the terms of the Mozilla Public
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - License, v. 2.0. If a copy of the MPL was not distributed with this
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - file, You can obtain one at http://mozilla.org/MPL/2.0/.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw-->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!-- Converted by db4-upgrade version 1.0 -->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <date>2009-10-05</date>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refentryinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <corpname>ISC</corpname>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refentryinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refmeta>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refentrytitle><application>pkcs11-list</application></refentrytitle>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <manvolnum>8</manvolnum>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <refmiscinfo>BIND9</refmiscinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refmeta>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refname><application>pkcs11-list</application></refname>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refpurpose>list PKCS#11 objects</refpurpose>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <docinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <copyright>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <year>2009</year>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <year>2014</year>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <year>2015</year>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <year>2016</year>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </copyright>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </docinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsynopsisdiv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <cmdsynopsis sepchar=" ">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <command>pkcs11-list</command>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat"><option>-P</option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </cmdsynopsis>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsynopsisdiv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsection><info><title>DESCRIPTION</title></info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <command>pkcs11-list</command>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw lists the PKCS#11 objects with <option>ID</option> or
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <option>label</option> or by default all objects.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw The object class, label, and ID are displayed for all
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw keys. For private or secret keys, the extractability
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw attribute is also displayed, as either <literal>true</literal>,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <literal>false</literal>, or <literal>never</literal>.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsection>
6537f381d2d9e7b4e2f7b29c3e7a3f13be036f2eas
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsection><info><title>ARGUMENTS</title></info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <variablelist>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <term>-P</term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw List only the public objects. (Note that on some PKCS#11
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw devices, all objects are private.)
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
6537f381d2d9e7b4e2f7b29c3e7a3f13be036f2eas <varlistentry>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <term>-m <replaceable class="parameter">module</replaceable></term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
3db3f65c6274eb042354801a308c8e9bc4994553amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Specify the PKCS#11 provider module. This must be the full
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw path to a shared library object implementing the PKCS#11 API
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw for the device.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <term>-s <replaceable class="parameter">slot</replaceable></term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Open the session with the given PKCS#11 slot. The default is
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw slot 0.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <term>-i <replaceable class="parameter">ID</replaceable></term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw List only key objects with the given object ID.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <term>-l <replaceable class="parameter">label</replaceable></term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw List only key objects with the given label.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <term>-p <replaceable class="parameter">PIN</replaceable></term>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Specify the PIN for the device. If no PIN is provided on the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw command line, <command>pkcs11-list</command> will prompt for it.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </listitem>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </variablelist>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsection>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
<refsection><info><title>SEE ALSO</title></info>
<para>
<citerefentry>
<refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-keygen</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsection>
</refentry>