pkcs11-keygen.html revision 247806c82065fc5dcc3d25cfdb0de2725553f237
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<!--
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont -
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - Permission to use, copy, modify, and/or distribute this software for any
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - purpose with or without fee is hereby granted, provided that the above
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - copyright notice and this permission notice appear in all copies.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont -
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - PERFORMANCE OF THIS SOFTWARE.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont-->
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<!-- $Id: pkcs11-keygen.html,v 1.3 2009/10/05 12:25:29 fdupont Exp $ -->
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<html>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<head>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<title>pkcs11-keygen</title>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</head>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<a name="man.pkcs11-keygen"></a><div class="titlepage"></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refnamediv">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<h2>Name</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p><span class="application">pkcs11-keygen</span> &#8212; generate RSA keys on a PKCS#11 device</p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsynopsisdiv">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<h2>Synopsis</h2>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<div class="cmdsynopsis"><p><code class="command">pkcs11-keygen</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>] [<code class="option">-e</code>] {-b <em class="replaceable"><code>keysize</code></em>} {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-i <em class="replaceable"><code>id</code></em></code>] [<code class="option">-p <em class="replaceable"><code>PIN</code></em></code>]</p></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsect1" lang="en">
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<a name="id2543397"></a><h2>DESCRIPTION</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont <span><strong class="command">pkcs11-keygen</strong></span> causes a PKCS#11 device to generate
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont a new RSA key pair with the specified <code class="option">label</code> and
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont with <code class="option">keysize</code> bits of modulus.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsect1" lang="en">
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<a name="id2543416"></a><h2>ARGUMENTS</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="variablelist"><dl>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-P</span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Set the new private key to be non-sensitive and extractable.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont The allows the private key data to be read from the PKCS#11
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont device. The default is for private keys to be sensitive and
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont non-extractable.
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>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<dt><span class="term">-e</span></dt>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<dd><p>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont Use a large exponent.
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<dd><p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Create the key pair with <code class="option">keysize</code> bits of
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont modulus.
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 Create key objects with the given label.
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont This name must be unique.
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont </p></dd>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<dt><span class="term">-i <em class="replaceable"><code>id</code></em></span></dt>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<dd><p>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont Create key objects with id. The id is either
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont an unsigned short 2 byte or an unsigned long 4 byte number.
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
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont command line, <span><strong class="command">pkcs11-keygen</strong></span> will prompt for it.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p></dd>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</dl></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsect1" lang="en">
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<a name="id2543563"></a><h2>SEE ALSO</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(3)</span>,
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(3)</span>,
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont <span class="citerefentry"><span class="refentrytitle">dnssec-keyfromlabel</span>(3)</span>,
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsect1" lang="en">
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<a name="id2543598"></a><h2>CAVEAT</h2>
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<p>Some PKCS#11 providers crash with big public exponent.</p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<div class="refsect1" lang="en">
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont<a name="id2543609"></a><h2>AUTHOR</h2>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p><span class="corpauthor">Internet Systems Consortium</span>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont </p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</div></body>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont</html>