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