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