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