pkcs11-keygen.docbook revision 474faea7dd5ebbf64e0a34d70f4deb2e3f413de6
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
816e576f77e2c46df3e3d97d65822aa8aded7c4bDavid Lawrence "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson [<!ENTITY mdash "&#8212;">]>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson<!--
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson -
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - Permission to use, copy, modify, and/or distribute this software for any
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - copyright notice and this permission notice appear in all copies.
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson -
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b2ca1f1bd04a779f15e12e0b2bee6fa95e512f89Brian Wellington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9dc499f133042bb8ab6e2089db708be0d13733bfBrian Wellington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b2ca1f1bd04a779f15e12e0b2bee6fa95e512f89Brian Wellington - PERFORMANCE OF THIS SOFTWARE.
1cb5d53b09cded8298285fdcdcc6a261f2b47afbBrian Wellington-->
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson<refentry id="man.pkcs11-keygen">
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <refentryinfo>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <date>January 15, 2014</date>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </refentryinfo>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <refmeta>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <refentrytitle><application>pkcs11-keygen</application></refentrytitle>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <manvolnum>8</manvolnum>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <refmiscinfo>BIND9</refmiscinfo>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </refmeta>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <refnamediv>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <refname><application>pkcs11-keygen</application></refname>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <refpurpose>generate keys on a PKCS#11 device</refpurpose>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </refnamediv>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <docinfo>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <copyright>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <year>2009</year>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <year>2014</year>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </copyright>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </docinfo>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <refsynopsisdiv>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <cmdsynopsis>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <command>pkcs11-keygen</command>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg choice="req">-a <replaceable class="parameter">algorithm</replaceable></arg>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg><option>-e</option></arg>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg><option>-i <replaceable class="parameter">id</replaceable></option></arg>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
5b4397d387b89d696b5eb90c328a385e07d4a380Brian Wellington <arg><option>-P</option></arg>
5b4397d387b89d696b5eb90c328a385e07d4a380Brian Wellington <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
5b4397d387b89d696b5eb90c328a385e07d4a380Brian Wellington <arg><option>-q</option></arg>
5b4397d387b89d696b5eb90c328a385e07d4a380Brian Wellington <arg><option>-S</option></arg>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
1cb5d53b09cded8298285fdcdcc6a261f2b47afbBrian Wellington <arg choice="req">label</arg>
1cb5d53b09cded8298285fdcdcc6a261f2b47afbBrian Wellington </cmdsynopsis>
1b855974958ebca91882c4b59f66c48dd5784b87Andreas Gustafsson </refsynopsisdiv>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <refsect1>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <title>DESCRIPTION</title>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <para>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson <command>pkcs11-keygen</command> causes a PKCS#11 device to generate
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson a new key pair with the given <option>label</option> (which must be
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson unique) and with <option>keysize</option> bits of prime.
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson </para>
c81bf797a812236e4a6d13a6473bc029d7ce280aAndreas Gustafsson </refsect1>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <refsect1>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <title>ARGUMENTS</title>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <variablelist>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <varlistentry>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <term>-a <replaceable class="parameter">algorithm</replaceable></term>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <listitem>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <para>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson Specify the key algorithm class: Supported classes are RSA,
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson DSA, DH, and ECC. In addition to these strings, the
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <option>algorithm</option> can be specified as a DNSSEC
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson signing algorithm that will be used with this key; for
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson to ECC. The default class is "RSA".
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson </para>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson </listitem>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson </varlistentry>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <varlistentry>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <term>-b <replaceable class="parameter">keysize</replaceable></term>
95b6b97ae0942ceb8244693c3d68d2b396af9960Andreas Gustafsson <listitem>
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington <para>
Create the key pair with <option>keysize</option> bits of
prime. For ECC keys, the only valid values are 256 and 384,
and the default is 256.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e</term>
<listitem>
<para>
For RSA keys only, use a large exponent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-i <replaceable class="parameter">id</replaceable></term>
<listitem>
<para>
Create key objects with id. The id is either
an unsigned short 2 byte or an unsigned long 4 byte number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-m <replaceable class="parameter">module</replaceable></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-P</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">PIN</replaceable></term>
<listitem>
<para>
Specify the PIN for the device. If no PIN is provided on
the command line, <command>pkcs11-keygen</command> will
prompt for it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e</term>
<listitem>
<para>
Quiet mode: suppress unnecessary output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s <replaceable class="parameter">slot</replaceable></term>
<listitem>
<para>
Open the session with the given PKCS#11 slot. The default is
slot 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pkcs11-rsagen</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-dsagen</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-list</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-keyfromlabel</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->