pkcs11-list.html revision d6fa26d0adaec6c910115be34fe7a5a5f402c14f
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!--
f0aad5341752aefe5059832f6cf3abc3283c6e16Tinderbox User - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - file, You can obtain one at http://mozilla.org/MPL/2.0/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein-->
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<html lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>pkcs11-list</title>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt</head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.pkcs11-list"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refnamediv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Name</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">pkcs11-list</span> &#8212; list PKCS#11 objects</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsynopsisdiv">
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<h2>Synopsis</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsection">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id-1.7"></a><h2>DESCRIPTION</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>pkcs11-list</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lists the PKCS#11 objects with <code class="option">ID</code> or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">label</code> or by default all objects.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The object class, label, and ID are displayed for all
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein keys. For private or secret keys, the extractability
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User attribute is also displayed, as either <code class="literal">true</code>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="literal">false</code>, or <code class="literal">never</code>.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsection">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="id-1.8"></a><h2>ARGUMENTS</h2>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<div class="variablelist"><dl class="variablelist">
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User<dt><span class="term">-P</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User List only the public objects. (Note that on some PKCS#11
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User devices, all objects are private.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specify the PKCS#11 provider module. This must be the full
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User path to a shared library object implementing the PKCS#11 API
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User for the device.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dd><p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Open the session with the given PKCS#11 slot. The default is
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updater slot 0.
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User </p></dd>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dd><p>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt List only key objects with the given object ID.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein List only key objects with the given label.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Specify the PIN for the device. If no PIN is provided on the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein command line, <span class="command"><strong>pkcs11-list</strong></span> will prompt for it.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User</dl></div>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsection">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id-1.9"></a><h2>SEE ALSO</h2>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User<p>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(8)</span>,
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(8)</span>,
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
aa1905addf2f33d90aa020080e4e77a8651e829aTinderbox User</div></body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</html>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User