pkcs11-list.html revision 33d0a7767d53cb366039fd0ac4f63cf8a9c351b0
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<!--
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn -
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - Permission to use, copy, modify, and/or distribute this software for any
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - purpose with or without fee is hereby granted, provided that the above
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - copyright notice and this permission notice appear in all copies.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn -
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn - PERFORMANCE OF THIS SOFTWARE.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn-->
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<html>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<head>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<title>pkcs11-list</title>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</head>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<a name="man.pkcs11-list"></a><div class="titlepage"></div>
061ba5d071e4c2b4bfe76c84875bc29cc5334c27Stéphane Graber<div class="refnamediv">
061ba5d071e4c2b4bfe76c84875bc29cc5334c27Stéphane Graber<h2>Name</h2>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<p><span class="application">pkcs11-list</span> &#8212; list PKCS#11 objects</p>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</div>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<div class="refsynopsisdiv">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<h2>Synopsis</h2>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<div class="cmdsynopsis"><p><code class="command">pkcs11-list</code> [<code class="option">-P</code>] [<code class="option">-m <em class="replaceable"><code>module</code></em></code>] [<code class="option">-s <em class="replaceable"><code>slot</code></em></code>] [-i <em class="replaceable"><code>ID</code></em>] [-l <em class="replaceable"><code>label</code></em>] [<code class="option">-p <em class="replaceable"><code>PIN</code></em></code>]</p></div>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</div>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<div class="refsection">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<a name="id-1.7"></a><h2>DESCRIPTION</h2>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<p>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber <span class="command"><strong>pkcs11-list</strong></span>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber lists the PKCS#11 objects with <code class="option">ID</code> or
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber <code class="option">label</code> or by default all objects.
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber The object class, label, and ID are displayed for all
061ba5d071e4c2b4bfe76c84875bc29cc5334c27Stéphane Graber keys. For private or secret keys, the extractability
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn attribute is also displayed, as either <code class="literal">true</code>,
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber <code class="literal">false</code>, or <code class="literal">never</code>.
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber </p>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber</div>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<div class="refsection">
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<a name="id-1.8"></a><h2>ARGUMENTS</h2>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<div class="variablelist"><dl class="variablelist">
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<dt><span class="term">-P</span></dt>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<dd><p>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn List only the public objects. (Note that on some PKCS#11
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber devices, all objects are private.)
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber </p></dd>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<dd><p>
198a3f10d2e9d28a3713abd8e63e02524240dbf6Stéphane Graber Specify the PKCS#11 provider module. This must be the full
198a3f10d2e9d28a3713abd8e63e02524240dbf6Stéphane Graber path to a shared library object implementing the PKCS#11 API
198a3f10d2e9d28a3713abd8e63e02524240dbf6Stéphane Graber for the device.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn </p></dd>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<dd><p>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn Open the session with the given PKCS#11 slot. The default is
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn slot 0.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn </p></dd>
fd2b7320e3562450111b5adaabcb7f6b9c8d9d13Stéphane Graber<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
fd2b7320e3562450111b5adaabcb7f6b9c8d9d13Stéphane Graber<dd><p>
fd2b7320e3562450111b5adaabcb7f6b9c8d9d13Stéphane Graber List only key objects with the given object ID.
fd2b7320e3562450111b5adaabcb7f6b9c8d9d13Stéphane Graber </p></dd>
fd2b7320e3562450111b5adaabcb7f6b9c8d9d13Stéphane Graber<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<dd><p>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber List only key objects with the given label.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn </p></dd>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<dd><p>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber Specify the PIN for the device. If no PIN is provided on the
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber command line, <span class="command"><strong>pkcs11-list</strong></span> will prompt for it.
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn </p></dd>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</dl></div>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber</div>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<div class="refsection">
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn<a name="id-1.9"></a><h2>SEE ALSO</h2>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber<p>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(8)</span>,
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(8)</span>,
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn </p>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</div>
d08363afbb40a7a8f579fe1ce60e40ffeaee5959Serge Hallyn</div></body>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber</html>
73d3e0903c728d5fdc4591c5d7cd157004461230Stéphane Graber