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