pkcs11-list.docbook revision f1a2709aad7baa4161fdb6f63edf99b0150af252
15938N/A<!--
15938N/A - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
15938N/A -
15938N/A - Permission to use, copy, modify, and/or distribute this software for any
15938N/A - purpose with or without fee is hereby granted, provided that the above
15938N/A - copyright notice and this permission notice appear in all copies.
15938N/A -
15938N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12877N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
12877N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
15938N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12877N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
15938N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15938N/A - PERFORMANCE OF THIS SOFTWARE.
15938N/A-->
15938N/A
15938N/A<!-- Converted by db4-upgrade version 1.0 -->
15938N/A<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-list">
15938N/A <info>
15938N/A <date>2009-10-05</date>
15938N/A </info>
12877N/A <refentryinfo>
15938N/A <corpname>ISC</corpname>
15938N/A <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
12877N/A </refentryinfo>
15938N/A
15938N/A <refmeta>
15938N/A <refentrytitle><application>pkcs11-list</application></refentrytitle>
15938N/A <manvolnum>8</manvolnum>
15938N/A <refmiscinfo>BIND9</refmiscinfo>
15938N/A </refmeta>
15938N/A
15938N/A <refnamediv>
15938N/A <refname><application>pkcs11-list</application></refname>
15938N/A <refpurpose>list PKCS#11 objects</refpurpose>
15938N/A </refnamediv>
15938N/A
15938N/A <docinfo>
15938N/A <copyright>
15938N/A <year>2009</year>
15938N/A <year>2014</year>
15938N/A <year>2015</year>
15938N/A <year>2016</year>
15938N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
15938N/A </copyright>
15938N/A </docinfo>
15938N/A
15938N/A <refsynopsisdiv>
12877N/A <cmdsynopsis sepchar=" ">
15938N/A <command>pkcs11-list</command>
15938N/A <arg choice="opt" rep="norepeat"><option>-P</option></arg>
15938N/A <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
15938N/A <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
15938N/A <arg choice="opt" rep="norepeat">-i <replaceable class="parameter">ID</replaceable></arg>
15938N/A <arg choice="opt" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
15938N/A <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
15938N/A </cmdsynopsis>
15938N/A </refsynopsisdiv>
15938N/A
15938N/A <refsection><info><title>DESCRIPTION</title></info>
15938N/A
15938N/A <para>
15938N/A <command>pkcs11-list</command>
15938N/A lists the PKCS#11 objects with <option>ID</option> or
15938N/A <option>label</option> or by default all objects.
15938N/A The object class, label, and ID are displayed for all
15938N/A keys. For private or secret keys, the extractability
15938N/A attribute is also displayed, as either <literal>true</literal>,
15938N/A <literal>false</literal>, or <literal>never</literal>.
15938N/A </para>
15938N/A </refsection>
15938N/A
15938N/A <refsection><info><title>ARGUMENTS</title></info>
15938N/A
15938N/A <variablelist>
15938N/A <varlistentry>
12877N/A <term>-P</term>
15938N/A <listitem>
15938N/A <para>
15938N/A List only the public objects. (Note that on some PKCS#11
15938N/A devices, all objects are private.)
12877N/A </para>
15938N/A </listitem>
15938N/A </varlistentry>
15938N/A
15938N/A <varlistentry>
12877N/A <term>-m <replaceable class="parameter">module</replaceable></term>
15938N/A <listitem>
15938N/A <para>
15938N/A Specify the PKCS#11 provider module. This must be the full
15938N/A path to a shared library object implementing the PKCS#11 API
15938N/A for the device.
15938N/A </para>
15938N/A </listitem>
15938N/A </varlistentry>
12877N/A
15938N/A <varlistentry>
15938N/A <term>-s <replaceable class="parameter">slot</replaceable></term>
15938N/A <listitem>
15938N/A <para>
12877N/A Open the session with the given PKCS#11 slot. The default is
15938N/A slot 0.
12877N/A </para>
15938N/A </listitem>
15938N/A </varlistentry>
12877N/A
15938N/A <varlistentry>
15938N/A <term>-i <replaceable class="parameter">ID</replaceable></term>
15938N/A <listitem>
15938N/A <para>
15938N/A List only key objects with the given object ID.
15938N/A </para>
12877N/A </listitem>
15938N/A </varlistentry>
15938N/A
15938N/A <varlistentry>
15938N/A <term>-l <replaceable class="parameter">label</replaceable></term>
15938N/A <listitem>
15938N/A <para>
12877N/A List only key objects with the given label.
15938N/A </para>
15938N/A </listitem>
12877N/A </varlistentry>
15938N/A
15938N/A <varlistentry>
15938N/A <term>-p <replaceable class="parameter">PIN</replaceable></term>
15938N/A <listitem>
15938N/A <para>
15938N/A Specify the PIN for the device. If no PIN is provided on the
15938N/A command line, <command>pkcs11-list</command> will prompt for it.
15938N/A </para>
15938N/A </listitem>
15938N/A </varlistentry>
15938N/A </variablelist>
15938N/A </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>