pkcs11-list.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<!--
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User -
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/.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont-->
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<html>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<head>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<title>pkcs11-list</title>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</head>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<a name="man.pkcs11-list"></a><div class="titlepage"></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refnamediv">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<h2>Name</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p><span class="application">pkcs11-list</span> &#8212; list PKCS#11 objects</p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsynopsisdiv">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<h2>Synopsis</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<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>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<div class="refsection">
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<a name="id-1.7"></a><h2>DESCRIPTION</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User <span class="command"><strong>pkcs11-list</strong></span>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont lists the PKCS#11 objects with <code class="option">ID</code> or
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont <code class="option">label</code> or by default all objects.
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User The object class, label, and ID are displayed for all
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User keys. For private or secret keys, the extractability
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User attribute is also displayed, as either <code class="literal">true</code>,
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User <code class="literal">false</code>, or <code class="literal">never</code>.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<div class="refsection">
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<a name="id-1.8"></a><h2>ARGUMENTS</h2>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<div class="variablelist"><dl class="variablelist">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-P</span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont List only the public objects. (Note that on some PKCS#11
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont devices, all objects are private.)
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Specify the PKCS#11 provider module. This must be the full
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont path to a shared library object implementing the PKCS#11 API
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont for the device.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Open the session with the given PKCS#11 slot. The default is
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont slot 0.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont List only key objects with the given object ID.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont List only key objects with the given label.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Specify the PIN for the device. If no PIN is provided on the
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User command line, <span class="command"><strong>pkcs11-list</strong></span> will prompt for it.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</dl></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<div class="refsection">
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User<a name="id-1.9"></a><h2>SEE ALSO</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p>
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(8)</span>,
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-keygen</span>(8)</span>,
33d0a7767d53cb366039fd0ac4f63cf8a9c351b0Tinderbox User <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div></body>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</html>