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