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