| blob | 5e03fe014ffae836bc2f6ccf5c1d68c50d9491cd |
1 .\" $NetBSD: pkcs11-keygen.8,v 1.5 2014/12/10 04:37:52 christos Exp $
2 .\"
3 .\" Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
4 .\"
5 .\" Permission to use, copy, modify, and/or distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 .\" PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .\" Id
18 .\"
19 .hy 0
20 .ad l
21 .\" Title: pkcs11\-ecgen
22 .\" Author:
23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
24 .\" Date: Feb 30, 2012
25 .\" Manual: BIND9
26 .\" Source: BIND9
27 .\"
28 .TH "PKCS11\-ECGEN" "8" "Feb 30, 2012" "BIND9" "BIND9"
29 .\" disable hyphenation
30 .nh
31 .\" disable justification (adjust text to left margin only)
32 .ad l
33 .SH "NAME"
34 pkcs11\-keygen \- generate keys on a PKCS#11 device
35 .SH "SYNOPSIS"
36 .HP 14
37 \fBpkcs11\-keygen\fR {\-a\ \fIalgorithm\fR} [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-e\fR] [\fB\-i\ \fR\fB\fIid\fR\fR] [\fB\-m\ \fR\fB\fImodule\fR\fR] [\fB\-P\fR] [\fB\-p\ \fR\fB\fIPIN\fR\fR] [\fB\-q\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIslot\fR\fR] {label}
38 .SH "DESCRIPTION"
39 .PP
40 \fBpkcs11\-keygen\fR
41 causes a PKCS#11 device to generate a new key pair with the given
42 \fBlabel\fR
43 (which must be unique) and with
44 \fBkeysize\fR
45 bits of prime.
46 .SH "ARGUMENTS"
47 .PP
48 \-a \fIalgorithm\fR
49 .RS 4
50 Specify the key algorithm class: Supported classes are RSA, DSA, DH, and ECC. In addition to these strings, the
51 \fBalgorithm\fR
52 can be specified as a DNSSEC signing algorithm that will be used with this key; for example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps to ECC. The default class is "RSA".
53 .RE
54 .PP
55 \-b \fIkeysize\fR
56 .RS 4
57 Create the key pair with
58 \fBkeysize\fR
59 bits of prime. For ECC keys, the only valid values are 256 and 384, and the default is 256.
60 .RE
61 .PP
62 \-e
63 .RS 4
64 For RSA keys only, use a large exponent.
65 .RE
66 .PP
67 \-i \fIid\fR
68 .RS 4
69 Create key objects with id. The id is either an unsigned short 2 byte or an unsigned long 4 byte number.
70 .RE
71 .PP
72 \-m \fImodule\fR
73 .RS 4
74 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.
75 .RE
76 .PP
77 \-P
78 .RS 4
79 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.
80 .RE
81 .PP
82 \-p \fIPIN\fR
83 .RS 4
84 Specify the PIN for the device. If no PIN is provided on the command line,
85 \fBpkcs11\-ecgen\fR
86 will prompt for it.
87 .RE
88 .PP
89 \-e
90 .RS 4
91 Quiet mode: suppress unnecessary output.
92 .RE
93 .PP
94 \-S
95 .RS 4
96 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.
97 .RE
98 .PP
99 \-s \fIslot\fR
100 .RS 4
101 Open the session with the given PKCS#11 slot. The default is slot 0.
102 .RE
103 .SH "SEE ALSO"
104 .PP
105 \fBpkcs11\-rsagen\fR(3),
106 \fBpkcs11\-dsagen\fR(3),
107 \fBpkcs11\-list\fR(3),
108 \fBpkcs11\-destroy\fR(3),
109 \fBdnssec\-keyfromlabel\fR(3),
110 .SH "AUTHOR"
111 .PP
112 Internet Systems Consortium
113 .SH "COPYRIGHT"
114 Copyright \(co 2012 Internet Systems Consortium, Inc. ("ISC")
115 .br