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