pkcs11-keygen.html revision ba751492fcc4f161a18b983d4f018a1a52938cb9
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater - Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and/or distribute this software for any
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - purpose with or without fee is hereby granted, provided that the above
0b062f4990db5cc6db2fe3398926f71b92a67407Brian Wellington - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9016767f4e15191b7c763b8a4ad36a57dc2705a2Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9016767f4e15191b7c763b8a4ad36a57dc2705a2Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
9016767f4e15191b7c763b8a4ad36a57dc2705a2Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9016767f4e15191b7c763b8a4ad36a57dc2705a2Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
9016767f4e15191b7c763b8a4ad36a57dc2705a2Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.pkcs11-ecgen"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">pkcs11-keygen</span> — generate keys on a PKCS#11 device</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="cmdsynopsis"><p><code class="command">pkcs11-keygen</code> {-a <em class="replaceable"><code>algorithm</code></em>} [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-e</code>] [<code class="option">-i <em class="replaceable"><code>id</code></em></code>] [<code class="option">-m <em class="replaceable"><code>module</code></em></code>] [<code class="option">-P</code>] [<code class="option">-p <em class="replaceable"><code>PIN</code></em></code>] [<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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">pkcs11-keygen</strong></span> causes a PKCS#11 device to generate
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a new key pair with the given <code class="option">label</code> (which must be
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews unique) and with <code class="option">keysize</code> bits of prime.
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater Specify the key algorithm class: Supported classes are RSA,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DSA, DH, and ECC. In addition to these strings, the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">algorithm</code> can be specified as a DNSSEC
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater signing algorithm that will be used with this key; for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to ECC. The default class is "RSA".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater Create the key pair with <code class="option">keysize</code> bits of
0e9e255d1643375056aa9ed7fe2a279713ffae78Automatic Updater prime. For ECC keys, the only valid values are 256 and 384,
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater and the default is 256.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater For RSA keys only, use a large exponent.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<dt><span class="term">-i <em class="replaceable"><code>id</code></em></span></dt>
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater Create key objects with id. The id is either
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater an unsigned short 2 byte or an unsigned long 4 byte number.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specify the PKCS#11 provider module. This must be the full
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater path to a shared library object implementing the PKCS#11 API
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater for the device.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater Set the new private key to be non-sensitive and extractable.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The allows the private key data to be read from the PKCS#11
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein device. The default is for private keys to be sensitive and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein non-extractable.
b272d38cc5d24f64c0647a9afb340c21c4b9aaf7Evan Hunt<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater Specify the PIN for the device. If no PIN is provided on
b272d38cc5d24f64c0647a9afb340c21c4b9aaf7Evan Hunt the command line, <span><strong class="command">pkcs11-ecgen</strong></span> will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein prompt for it.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater Quiet mode: suppress unnecessary output.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater For Diffie-Hellman (DH) keys only, use a special prime of
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater 768, 1024 or 1536 bit size and base (aka generator) 2.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater If not specified, bit size will default to 1024.
b272d38cc5d24f64c0647a9afb340c21c4b9aaf7Evan Hunt<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Open the session with the given PKCS#11 slot. The default is
2f8d63983c297c62630044d28a6f66676b4d339dMark Andrews <span class="citerefentry"><span class="refentrytitle">pkcs11-rsagen</span>(3)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">pkcs11-dsagen</span>(3)</span>,
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(3)</span>,
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(3)</span>,
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <span class="citerefentry"><span class="refentrytitle">dnssec-keyfromlabel</span>(3)</span>,
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<p><span class="corpauthor">Internet Systems Consortium</span>