man.pkcs11-keygen.html revision 1ca759b3f5c0672b2a66bc02288fe010cabbfe37
f072359f493a5209335799da85ac16d6a273303bgryzor<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
f072359f493a5209335799da85ac16d6a273303bgryzor<!--
f072359f493a5209335799da85ac16d6a273303bgryzor - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
f072359f493a5209335799da85ac16d6a273303bgryzor -
f072359f493a5209335799da85ac16d6a273303bgryzor - This Source Code Form is subject to the terms of the Mozilla Public
f072359f493a5209335799da85ac16d6a273303bgryzor - License, v. 2.0. If a copy of the MPL was not distributed with this
f072359f493a5209335799da85ac16d6a273303bgryzor - file, You can obtain one at http://mozilla.org/MPL/2.0/.
f072359f493a5209335799da85ac16d6a273303bgryzor-->
f072359f493a5209335799da85ac16d6a273303bgryzor<html lang="en">
f072359f493a5209335799da85ac16d6a273303bgryzor<head>
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<title>pkcs11-keygen</title>
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
f072359f493a5209335799da85ac16d6a273303bgryzor<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
f072359f493a5209335799da85ac16d6a273303bgryzor<link rel="prev" href="man.pkcs11-list.html" title="pkcs11-list">
f072359f493a5209335799da85ac16d6a273303bgryzor<link rel="next" href="man.pkcs11-tokens.html" title="pkcs11-tokens">
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen</head>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="navheader">
f072359f493a5209335799da85ac16d6a273303bgryzor<table width="100%" summary="Navigation header">
f072359f493a5209335799da85ac16d6a273303bgryzor<tr><th colspan="3" align="center"><span class="application">pkcs11-keygen</span></th></tr>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<tr>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="20%" align="left">
f072359f493a5209335799da85ac16d6a273303bgryzor<a accesskey="p" href="man.pkcs11-list.html">Prev</a>�</td>
f072359f493a5209335799da85ac16d6a273303bgryzor<th width="60%" align="center">Manual pages</th>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="20%" align="right">�<a accesskey="n" href="man.pkcs11-tokens.html">Next</a>
f072359f493a5209335799da85ac16d6a273303bgryzor</td>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung</tr>
f072359f493a5209335799da85ac16d6a273303bgryzor</table>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<hr>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="refentry">
f072359f493a5209335799da85ac16d6a273303bgryzor<a name="man.pkcs11-keygen"></a><div class="titlepage"></div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="refnamediv">
f072359f493a5209335799da85ac16d6a273303bgryzor<h2>Name</h2>
f072359f493a5209335799da85ac16d6a273303bgryzor<p><span class="application">pkcs11-keygen</span> &#8212; generate keys on a PKCS#11 device</p>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="refsynopsisdiv">
f072359f493a5209335799da85ac16d6a273303bgryzor<h2>Synopsis</h2>
f072359f493a5209335799da85ac16d6a273303bgryzor<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>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="refsection">
f072359f493a5209335799da85ac16d6a273303bgryzor<a name="id-1.14.38.7"></a><h2>DESCRIPTION</h2>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic <span class="command"><strong>pkcs11-keygen</strong></span> causes a PKCS#11 device to generate
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic a new key pair with the given <code class="option">label</code> (which must be
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic unique) and with <code class="option">keysize</code> bits of prime.
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic</div>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<div class="refsection">
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<a name="id-1.14.38.8"></a><h2>ARGUMENTS</h2>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<div class="variablelist"><dl class="variablelist">
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dd><p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic Specify the key algorithm class: Supported classes are RSA,
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic DSA, DH, and ECC. In addition to these strings, the
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic <code class="option">algorithm</code> can be specified as a DNSSEC
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic signing algorithm that will be used with this key; for
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic to ECC. The default class is "RSA".
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p></dd>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dd><p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic Create the key pair with <code class="option">keysize</code> bits of
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic prime. For ECC keys, the only valid values are 256 and 384,
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic and the default is 256.
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p></dd>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dt><span class="term">-e</span></dt>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dd><p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic For RSA keys only, use a large exponent.
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p></dd>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dt><span class="term">-i <em class="replaceable"><code>id</code></em></span></dt>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dd><p>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim Create key objects with id. The id is either
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic an unsigned short 2 byte or an unsigned long 4 byte number.
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p></dd>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic<dt><span class="term">-m <em class="replaceable"><code>module</code></em></span></dt>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim<dd><p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic Specify the PKCS#11 provider module. This must be the full
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic path to a shared library object implementing the PKCS#11 API
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic for the device.
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic </p></dd>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim<dt><span class="term">-P</span></dt>
f072359f493a5209335799da85ac16d6a273303bgryzor<dd><p>
f072359f493a5209335799da85ac16d6a273303bgryzor Set the new private key to be non-sensitive and extractable.
f072359f493a5209335799da85ac16d6a273303bgryzor The allows the private key data to be read from the PKCS#11
f072359f493a5209335799da85ac16d6a273303bgryzor device. The default is for private keys to be sensitive and
f072359f493a5209335799da85ac16d6a273303bgryzor non-extractable.
f072359f493a5209335799da85ac16d6a273303bgryzor </p></dd>
f072359f493a5209335799da85ac16d6a273303bgryzor<dt><span class="term">-p <em class="replaceable"><code>PIN</code></em></span></dt>
f072359f493a5209335799da85ac16d6a273303bgryzor<dd><p>
f072359f493a5209335799da85ac16d6a273303bgryzor Specify the PIN for the device. If no PIN is provided on
f072359f493a5209335799da85ac16d6a273303bgryzor the command line, <span class="command"><strong>pkcs11-keygen</strong></span> will
45a544a8bb3fa1f95e5edac9fb3e723e2bb7001drbowen prompt for it.
15e38d431fea66258ef33960b39edee496c3c9c2humbedooh </p></dd>
f072359f493a5209335799da85ac16d6a273303bgryzor<dt><span class="term">-q</span></dt>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim<dd><p>
f072359f493a5209335799da85ac16d6a273303bgryzor Quiet mode: suppress unnecessary output.
f072359f493a5209335799da85ac16d6a273303bgryzor </p></dd>
4c47688d73a9a5ef2735cd84f334b8eb814c74f0igalic<dt><span class="term">-S</span></dt>
f072359f493a5209335799da85ac16d6a273303bgryzor<dd><p>
f072359f493a5209335799da85ac16d6a273303bgryzor For Diffie-Hellman (DH) keys only, use a special prime of
f072359f493a5209335799da85ac16d6a273303bgryzor 768, 1024 or 1536 bit size and base (aka generator) 2.
f072359f493a5209335799da85ac16d6a273303bgryzor If not specified, bit size will default to 1024.
f072359f493a5209335799da85ac16d6a273303bgryzor </p></dd>
f072359f493a5209335799da85ac16d6a273303bgryzor<dt><span class="term">-s <em class="replaceable"><code>slot</code></em></span></dt>
f072359f493a5209335799da85ac16d6a273303bgryzor<dd><p>
f072359f493a5209335799da85ac16d6a273303bgryzor Open the session with the given PKCS#11 slot. The default is
f072359f493a5209335799da85ac16d6a273303bgryzor slot 0.
f072359f493a5209335799da85ac16d6a273303bgryzor </p></dd>
f072359f493a5209335799da85ac16d6a273303bgryzor</dl></div>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="refsection">
f072359f493a5209335799da85ac16d6a273303bgryzor<a name="id-1.14.38.9"></a><h2>SEE ALSO</h2>
f072359f493a5209335799da85ac16d6a273303bgryzor<p>
f072359f493a5209335799da85ac16d6a273303bgryzor <span class="citerefentry"><span class="refentrytitle">pkcs11-destroy</span>(8)</span>,
f072359f493a5209335799da85ac16d6a273303bgryzor <span class="citerefentry"><span class="refentrytitle">pkcs11-list</span>(8)</span>,
f072359f493a5209335799da85ac16d6a273303bgryzor <span class="citerefentry"><span class="refentrytitle">pkcs11-tokens</span>(8)</span>,
f072359f493a5209335799da85ac16d6a273303bgryzor <span class="citerefentry"><span class="refentrytitle">dnssec-keyfromlabel</span>(8)</span>
ee649f9236fe7fcf255bbfa11f2cce080f996521sf </p>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<div class="navfooter">
f072359f493a5209335799da85ac16d6a273303bgryzor<hr>
f072359f493a5209335799da85ac16d6a273303bgryzor<table width="100%" summary="Navigation footer">
f072359f493a5209335799da85ac16d6a273303bgryzor<tr>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="40%" align="left">
f072359f493a5209335799da85ac16d6a273303bgryzor<a accesskey="p" href="man.pkcs11-list.html">Prev</a>�</td>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
ac2a72149b423e2e84596098d7e47af88ebd215asf<td width="40%" align="right">�<a accesskey="n" href="man.pkcs11-tokens.html">Next</a>
f072359f493a5209335799da85ac16d6a273303bgryzor</td>
f072359f493a5209335799da85ac16d6a273303bgryzor</tr>
f072359f493a5209335799da85ac16d6a273303bgryzor<tr>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="40%" align="left" valign="top">
f072359f493a5209335799da85ac16d6a273303bgryzor<span class="application">pkcs11-list</span>�</td>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
f072359f493a5209335799da85ac16d6a273303bgryzor<td width="40%" align="right" valign="top">�<span class="application">pkcs11-tokens</span>
f072359f493a5209335799da85ac16d6a273303bgryzor</td>
f072359f493a5209335799da85ac16d6a273303bgryzor</tr>
f072359f493a5209335799da85ac16d6a273303bgryzor</table>
f072359f493a5209335799da85ac16d6a273303bgryzor</div>
f072359f493a5209335799da85ac16d6a273303bgryzor<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0</p>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic</body>
f072359f493a5209335799da85ac16d6a273303bgryzor</html>
70f5253b24dd333c67fb6502d557a8b48ad3ba87igalic