pkcs11-keygen.html revision 46bb3884a0738664862e3a36b7848aa374aebd45
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<!--
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - Copyright (C) 2009, 2014-2017 Internet Systems Consortium, Inc. ("ISC")
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync -
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - This Source Code Form is subject to the terms of the Mozilla Public
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - License, v. 2.0. If a copy of the MPL was not distributed with this
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - file, You can obtain one at http://mozilla.org/MPL/2.0/.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync-->
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<html lang="en">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<head>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<title>pkcs11-keygen</title>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync</head>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<a name="man.pkcs11-keygen"></a><div class="titlepage"></div>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <div class="refnamediv">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<h2>Name</h2>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <span class="application">pkcs11-keygen</span>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync &#8212; generate keys on a PKCS#11 device
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync</div>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <div class="refsynopsisdiv">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<h2>Synopsis</h2>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <div class="cmdsynopsis"><p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <code class="command">pkcs11-keygen</code>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync {-a <em class="replaceable"><code>algorithm</code></em>}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-e</code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-i <em class="replaceable"><code>id</code></em></code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-m <em class="replaceable"><code>module</code></em></code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-P</code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-p <em class="replaceable"><code>PIN</code></em></code>]
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<code class="option">-q</code>]
[<code class="option">-S</code>]
[<code class="option">-s <em class="replaceable"><code>slot</code></em></code>]
{label}
</p></div>
</div>
<div class="refsection">
<a name="id-1.7"></a><h2>DESCRIPTION</h2>
<p>
<span class="command"><strong>pkcs11-keygen</strong></span> causes a PKCS#11 device to generate
a new key pair with the given <code class="option">label</code> (which must be
unique) and with <code class="option">keysize</code> bits of prime.
</p>
</div>
<div class="refsection">
<a name="id-1.8"></a><h2>ARGUMENTS</h2>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
Specify the key algorithm class: Supported classes are RSA,
DSA, DH, ECC and ECX. In addition to these strings, the
<code class="option">algorithm</code> can be specified as a DNSSEC
signing algorithm that will be used with this key; for
example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps
to ECC, and ED25519 to ECX. The default class is "RSA".
</p>
</dd>
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
<dd>
<p>
Create the key pair with <code class="option">keysize</code> bits of
prime. For ECC keys, the only valid values are 256 and 384,
and the default is 256. For ECX kyes, the only valid values
are 256 and 456, and the default is 256.
</p>
</dd>
<dt><span class="term">-e</span></dt>
<dd>
<p>
For RSA keys only, use a large exponent.
</p>
</dd>
<dt><span class="term">-i <em class="replaceable"><code>id</code></em></span></dt>
<dd>
<p>
Create key objects with id. The id is either
an unsigned short 2 byte or an unsigned long 4 byte number.
</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">-P</span></dt>
<dd>
<p>
Set the new private key to be non-sensitive and extractable.
The allows the private key data to be read from the PKCS#11
device. The default is for private keys to be sensitive and
non-extractable.
</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-keygen</strong></span> will
prompt for it.
</p>
</dd>
<dt><span class="term">-q</span></dt>
<dd>
<p>
Quiet mode: suppress unnecessary output.
</p>
</dd>
<dt><span class="term">-S</span></dt>
<dd>
<p>
For Diffie-Hellman (DH) keys only, use a special prime of
768, 1024 or 1536 bit size and base (aka generator) 2.
If not specified, bit size will default to 1024.
</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>
</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-list</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">pkcs11-tokens</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">dnssec-keyfromlabel</span>(8)
</span>
</p>
</div>
</div></body>
</html>