.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
..
.. SPDX-License-Identifier: MPL-2.0
..
.. This Source Code Form is subject to the terms of the Mozilla Public
.. License, v. 2.0.  If a copy of the MPL was not distributed with this
.. file, you can obtain one at https://mozilla.org/MPL/2.0/.
..
.. See the COPYRIGHT file distributed with this work for additional
.. information regarding copyright ownership.

.. highlight: console

.. _man_pkcs11-keygen:

pkcs11-keygen - generate keys on a PKCS#11 device
-------------------------------------------------

Synopsis
~~~~~~~~

:program:`pkcs11-keygen` [**-a** algorithm] [**-b** keysize] [**-e**] [**-i** id] [**-m** module] [**-P**] [**-p** PIN] [**-q**] [**-S**] [**-s** slot] label

Description
~~~~~~~~~~~

``pkcs11-keygen`` causes a PKCS#11 device to generate a new key pair
with the given ``label`` (which must be unique) and with ``keysize``
bits of prime.

Options
~~~~~~~

``-a algorithm``
   This option specifies the key algorithm class: supported classes are RSA, DSA, DH,
   ECC, and ECX. In addition to these strings, the ``algorithm`` can be
   specified as a DNSSEC signing algorithm to be used with this
   key; for example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps to
   ECC, and ED25519 to ECX. The default class is ``RSA``.

``-b keysize``
   This option creates the key pair with ``keysize`` bits of prime. For ECC keys, the
   only valid values are 256 and 384, and the default is 256. For ECX
   keys, the only valid values are 256 and 456, and the default is 256.

``-e``
   For RSA keys only, this option specifies use of a large exponent.

``-i id``
   This option creates key objects with ``id``. The ID is either an unsigned short 2-byte
   or an unsigned long 4-byte number.

``-m module``
   This option specifies the PKCS#11 provider module. This must be the full path to a
   shared library object implementing the PKCS#11 API for the device.

``-P``
   This option sets the new private key to be non-sensitive and extractable, and
   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.

``-p PIN``
   This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command
   line, ``pkcs11-keygen`` prompts for it.

``-q``
   This option sets quiet mode, which suppresses unnecessary output.

``-S``
   For Diffie-Hellman (DH) keys only, this option specifies use of a special prime of 768-, 1024-,
   or 1536-bit size and base (AKA generator) 2. If not specified, bit
   size defaults to 1024.

``-s slot``
   This option opens the session with the given PKCS#11 slot. The default is slot 0.

See Also
~~~~~~~~

:manpage:`pkcs11-destroy(8)`, :manpage:`pkcs11-list(8)`, :manpage:`pkcs11-tokens(8)`, :manpage:`dnssec-keyfromlabel(8)`