bin/pkcs11/pkcs11-list.html

1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews -
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
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt - file, You can obtain one at http://mozilla.org/MPL/2.0/.
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt-->
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<html lang="en">
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<head>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<title>pkcs11-list</title>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt</head>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<a name="man.pkcs11-list"></a><div class="titlepage"></div>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt  <div class="refnamediv">
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<h2>Name</h2>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt<p>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt    <span class="application">pkcs11-list</span>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt     &#8212; list PKCS#11 objects
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt  </p>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt</div>
1479200aa05414b2acf33607dbd1682c16f58c51Evan Hunt


  <div class="refsynopsisdiv">
<h2>Synopsis</h2>
    <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>
  </div>

  <div class="refsection">
<a name="id-1.7"></a><h2>DESCRIPTION</h2>

    <p>
      <span class="command"><strong>pkcs11-list</strong></span>
      lists the PKCS#11 objects with <code class="option">ID</code> or
      <code class="option">label</code> or by default all objects.
      The object class, label, and ID are displayed for all
      keys.  For private or secret keys, the extractability
      attribute is also displayed, as either <code class="literal">true</code>,
      <code class="literal">false</code>, or <code class="literal">never</code>.
    </p>
  </div>

  <div class="refsection">
<a name="id-1.8"></a><h2>ARGUMENTS</h2>

    <div class="variablelist"><dl class="variablelist">
<dt><span class="term">-P</span></dt>
<dd>
          <p>
            List only the public objects. (Note that on some PKCS#11
            devices, all objects are private.)
          </p>
        </dd>
<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
<dd>
          <p>
            Specify the PKCS#11 provider module.  This must be the full
            path to a shared library object implementing the PKCS#11 API
            for the device.
          </p>
        </dd>
<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
<dd>
          <p>
            Open the session with the given PKCS#11 slot.  The default is
            slot 0.
          </p>
        </dd>
<dt><span class="term">-i <em class="replaceable"><code>ID</code></em></span></dt>
<dd>
          <p>
            List only key objects with the given object ID.
          </p>
        </dd>
<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
<dd>
          <p>
            List only key objects with the given label.
          </p>
        </dd>
<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
<dd>
          <p>
            Specify the PIN for the device.  If no PIN is provided on the
            command line, <span class="command"><strong>pkcs11-list</strong></span> will prompt for it.
          </p>
        </dd>
</dl></div>
  </div>

  <div class="refsection">
<a name="id-1.9"></a><h2>SEE ALSO</h2>

    <p>
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-destroy</span>(8)
      </span>,
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-keygen</span>(8)
      </span>,
      <span class="citerefentry">
        <span class="refentrytitle">pkcs11-tokens</span>(8)
      </span>
    </p>
  </div>

</div></body>
</html>