pkcs11-keygen.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - Permission to use, copy, modify, and/or distribute this software for any
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - purpose with or without fee is hereby granted, provided that the above
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - copyright notice and this permission notice appear in all copies.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
0662ed52e814f8f08ef0e09956413a792584eddffuankg - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes - PERFORMANCE OF THIS SOFTWARE.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<!-- Converted by db4-upgrade version 1.0 -->
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.pkcs11-keygen">
16b55a35cff91315d261d1baa776138af465c4e4fuankg <refentryinfo>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refentryinfo>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refentrytitle><application>pkcs11-keygen</application></refentrytitle>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refnamediv>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refname><application>pkcs11-keygen</application></refname>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refpurpose>generate keys on a PKCS#11 device</refpurpose>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refnamediv>
9558e9fdb620dd6f42ca93beac6c3ab734086706bnicholes <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
9558e9fdb620dd6f42ca93beac6c3ab734086706bnicholes </copyright>
9558e9fdb620dd6f42ca93beac6c3ab734086706bnicholes <refsynopsisdiv>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="req" rep="norepeat">-a <replaceable class="parameter">algorithm</replaceable></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-e</option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">id</replaceable></option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">module</replaceable></option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-P</option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-q</option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-S</option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </cmdsynopsis>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refsynopsisdiv>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refsection><info><title>DESCRIPTION</title></info>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <command>pkcs11-keygen</command> causes a PKCS#11 device to generate
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes a new key pair with the given <option>label</option> (which must be
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg unique) and with <option>keysize</option> bits of prime.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refsection>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <variablelist>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <term>-a <replaceable class="parameter">algorithm</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Specify the key algorithm class: Supported classes are RSA,
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes DSA, DH, and ECC. In addition to these strings, the
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <option>algorithm</option> can be specified as a DNSSEC
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg signing algorithm that will be used with this key; for
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes to ECC. The default class is "RSA".
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <term>-b <replaceable class="parameter">keysize</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Create the key pair with <option>keysize</option> bits of
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes prime. For ECC keys, the only valid values are 256 and 384,
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes and the default is 256.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg For RSA keys only, use a large exponent.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <term>-i <replaceable class="parameter">id</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Create key objects with id. The id is either
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes an unsigned short 2 byte or an unsigned long 4 byte number.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg <varlistentry>
0662ed52e814f8f08ef0e09956413a792584eddffuankg <term>-m <replaceable class="parameter">module</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Specify the PKCS#11 provider module. This must be the full
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes path to a shared library object implementing the PKCS#11 API
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes for the device.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Set the new private key to be non-sensitive and extractable.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes The allows the private key data to be read from the PKCS#11
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes device. The default is for private keys to be sensitive and
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes non-extractable.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <term>-p <replaceable class="parameter">PIN</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Specify the PIN for the device. If no PIN is provided on
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes the command line, <command>pkcs11-keygen</command> will
0662ed52e814f8f08ef0e09956413a792584eddffuankg prompt for it.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Quiet mode: suppress unnecessary output.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes For Diffie-Hellman (DH) keys only, use a special prime of
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes 768, 1024 or 1536 bit size and base (aka generator) 2.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes If not specified, bit size will default to 1024.
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <term>-s <replaceable class="parameter">slot</replaceable></term>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes Open the session with the given PKCS#11 slot. The default is
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </varlistentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </variablelist>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refsection>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <citerefentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>8</manvolnum>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </citerefentry>,
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <citerefentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refentrytitle>pkcs11-list</refentrytitle><manvolnum>8</manvolnum>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </citerefentry>,
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <citerefentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refentrytitle>pkcs11-tokens</refentrytitle><manvolnum>8</manvolnum>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </citerefentry>,
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <citerefentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <refentrytitle>dnssec-keyfromlabel</refentrytitle><manvolnum>8</manvolnum>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </citerefentry>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes </refsection>