pkcs11-keygen.docbook revision bf0266f286c9350f6579d03cc74429433d8e6381
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson [<!ENTITY mdash "—">]>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - Permission to use, copy, modify, and/or distribute this software for any
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - copyright notice and this permission notice appear in all copies.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - PERFORMANCE OF THIS SOFTWARE.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentryinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </refentryinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle><application>pkcs11-ecgen</application></refentrytitle>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refname><application>pkcs11-keygen</application></refname>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refpurpose>generate keys on a PKCS#11 device</refpurpose>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg choice="req">-a <replaceable class="parameter">algorithm</replaceable></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-i <replaceable class="parameter">id</replaceable></option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-m <replaceable class="parameter">module</replaceable></option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-p <replaceable class="parameter">PIN</replaceable></option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <arg><option>-s <replaceable class="parameter">slot</replaceable></option></arg>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </cmdsynopsis>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <command>pkcs11-keygen</command> causes a PKCS#11 device to generate
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson a new key pair with the given <option>label</option> (which must be
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unique) and with <option>keysize</option> bits of prime.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <variablelist>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-a <replaceable class="parameter">algorithm</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Specify the key algorithm class: Supported classes are RSA,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson DSA, DH, and ECC. In addition to these strings, the
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <option>algorithm</option> can be specified as a DNSSEC
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson signing algorithm that will be used with this key; for
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson to ECC. The default class is "RSA".
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-b <replaceable class="parameter">keysize</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Create the key pair with <option>keysize</option> bits of
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson prime. For ECC keys, the only valid values are 256 and 384,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson and the default is 256.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson For RSA keys only, use a large exponent.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-i <replaceable class="parameter">id</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Create key objects with id. The id is either
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson an unsigned short 2 byte or an unsigned long 4 byte number.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-m <replaceable class="parameter">module</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Specify the PKCS#11 provider module. This must be the full
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson path to a shared library object implementing the PKCS#11 API
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson for the device.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Set the new private key to be non-sensitive and extractable.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson The allows the private key data to be read from the PKCS#11
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson device. The default is for private keys to be sensitive and
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson non-extractable.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-p <replaceable class="parameter">PIN</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Specify the PIN for the device. If no PIN is provided on
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson the command line, <command>pkcs11-ecgen</command> will
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson prompt for it.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Quiet mode: suppress unnecessary output.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson For Diffie-Hellman (DH) keys only, use a special prime of
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson 768, 1024 or 1536 bit size and base (aka generator) 2.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson If not specified, bit size will default to 1024.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term>-s <replaceable class="parameter">slot</replaceable></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson Open the session with the given PKCS#11 slot. The default is
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </variablelist>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>pkcs11-rsagen</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>pkcs11-dsagen</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>pkcs11-list</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>pkcs11-destroy</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>dnssec-keyfromlabel</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para><corpauthor>Internet Systems Consortium</corpauthor>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - Local variables: